Skip to content

Commit

Permalink
filestore: Update documentation regarding locks
Browse files Browse the repository at this point in the history
Reported in #1110
  • Loading branch information
Acconut committed Apr 23, 2024
1 parent ad0533a commit e11711f
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pkg/filestore/filestore.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
// `[id]` files without an extension contain the raw binary data uploaded.
// No cleanup is performed so you may want to run a cronjob to ensure your disk
// is not filled up with old and finished uploads.
//
// Related to the filestore is the package filelocker, which provides a file-based
// locking mechanism. The use of some locking method is recommended and further
// explained in https://tus.github.io/tusd/advanced-topics/locks/.
package filestore

import (
Expand Down Expand Up @@ -34,7 +38,6 @@ type FileStore struct {
// New creates a new file based storage backend. The directory specified will
// be used as the only storage entry. This method does not check
// whether the path exists, use os.MkdirAll to ensure.
// In addition, a locking mechanism is provided.
func New(path string) FileStore {
return FileStore{path}
}
Expand Down

0 comments on commit e11711f

Please sign in to comment.