Better comments, Unlock test.

Add better comments for several functions, fixing errors and clarifying
intent.

Add a test for a lock's Handle and its Unlock method. Clarify that
Unlock is intended to panic if called multiple times after a single
success. Additionally, add implementations for this feature.
4 files changed
tree: c61a75e6f0a381a0d7b7e03ac79b7c19f8a82589
  1. fslock/
  2. .travis.yml
  3. LICENSE
  4. pre-commit-go.yml
  5. README.md
README.md

gofslock

Go implementation of filesystem-level locking.

GoDoc Build Status

Feedback

Request features and report bugs using the GitHub Issue Tracker.

Contributions

Contributions to this project are welcome, though please file an issue. before starting work on anything major.

To get started contributing to this project, clone the repository:

git clone https://github.com/danjacques/gofslock

This repository uses pre-commit-go to validate itself. Please install this prior to working on the project:

  • Make sure your user.email and user.name are configured in git config.
  • Install test-only packages: go get -u -t github.com/danjacques/gofslock/...
  • Install the pcg git hook: go get -u github.com/maruel/pre-commit-go/cmd/... && pcg