Skip to content

Commit

Permalink
Fix doc comments of exported funcs
Browse files Browse the repository at this point in the history
  • Loading branch information
dragotin committed Feb 17, 2022
1 parent 51ee1aa commit fd9e6d9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion pkg/storage/utils/filelocks/filelocks.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import (
"github.com/gofrs/flock"
)

// flockFile returns the flock filename for a given file name
// FlockFile returns the flock filename for a given file name
// it returns an empty string if the input is empty
func FlockFile(file string) string {
var n string
Expand Down Expand Up @@ -73,6 +73,8 @@ func AcquireWriteLock(file string) (*flock.Flock, error) {
return acquireLock(file, true)
}

// ReleaseLock releases a lock from a file that was previously created
// by AcquireReadLock or AcquireWriteLock.
func ReleaseLock(lock *flock.Flock) error {
// there is a probability that if the file can not be unlocked,
// we also can not remove the file. We will only try to remove if it
Expand Down

0 comments on commit fd9e6d9

Please sign in to comment.