Add lock command docs

This commit is contained in:
risk danger olson 2017-02-13 16:11:59 -07:00
parent 816c5d5338
commit 94e30aa29e
4 changed files with 112 additions and 2 deletions

@ -12,12 +12,12 @@ lfs option can be scoped inside the configuration for a remote.
### General settings
* `lfs.url` / `<remote>.lfsurl`
* `lfs.url` / `remote.<remote>.lfsurl`
The url used to call the Git LFS remote API. Default blank (derive from clone
URL).
* `lfs.pushurl` / `<remote>.lfspushurl`
* `lfs.pushurl` / `remote.<remote>.lfspushurl`
The url used to call the Git LFS remote API when pushing. Default blank (derive
from either LFS non-push urls or clone url).
@ -184,6 +184,22 @@ lfs option can be scoped inside the configuration for a remote.
If set to "basic" then credentials will be requested before making batch
requests to this url, otherwise a public request will initially be attempted.
* `lfs.<url>.skiplocksverify`
Determines whether locks are checked before Git pushes. This prevents you from
pushing changes to files that other users have locked. The Git LFS pre-push
hook varies its behavior based on the value of this config key.
* `null` - In the absence of a value, Git LFS will attempt the call, and warn
if it returns an error. If the response is valid, Git LFS will set the value
to `true`, and will halt the push if the user attempts to update a file locked
by another user. If the server returns a `501 Not Implemented` response, Git
LFS will set the value to `false.`
* `true` - Git LFS will attempt to verify locks, halting the Git push if there
are any server issues, or if the user attempts to update a file locked by
another user.
* `false` - Git LFS will completely skip the lock check in the pre-push hook.
* `lfs.skipdownloaderrors`
Causes Git LFS not to abort the smudge filter when a download error is

@ -0,0 +1,26 @@
git-lfs-lock(1) -- Set a file as "locked" on the Git LFS server
===============================================================
## SYNOPSIS
`git lfs lock` [options] <path>
## DESCRIPTION
Sets the given file path as "locked" against the Git LFS server, with the
intention of blocking attempts by other users to update the given path.
## OPTIONS
* `-r` <name> `--remote=`<name>:
Specify the Git LFS server to use. Ignored if the `lfs.url` config key is set.
* `--json`:
Writes lock info as JSON to STDOUT. Intended for interoperation with external
tools.
## SEE ALSO
git-lfs-unlock(1), git-lfs-locks(1).
Part of the git-lfs(1) suite.

@ -0,0 +1,37 @@
git-lfs-locks(1) -- Lists currently locked files from the Git LFS server.
=============================================================================
## SYNOPSIS
`git lfs locks` [options]
## DESCRIPTION
Lists current locks from the Git LFS server.
## OPTIONS
* `-r` <name> `--remote=`<name>:
Specify the Git LFS server to use. Ignored if the `lfs.url` config key is set.
* `-i <id>` `--id=<id>`:
Specifies a lock by its ID.
* `-p <path>` `--path=<path>`:
Specifies a lock by its path.
* `--local`:
Lists only the locks cached locally. Skips a remote call.
* `-l <num>` `--limit=<num>`:
Specifies number of results to return.
* `--json`:
Writes lock info as JSON to STDOUT. Intended for interoperation with external
tools.
## SEE ALSO
git-lfs-lock(1), git-lfs-unlock(1).
Part of the git-lfs(1) suite.

@ -0,0 +1,31 @@
git-lfs-unlock(1) -- Remove "locked" setting for a file on the Git LFS server
=============================================================================
## SYNOPSIS
`git lfs unlock` [options] <path>
## DESCRIPTION
Removes the given file path as "locked" on the Git LFS server.
## OPTIONS
* `-r` <name> `--remote=`<name>:
Specify the Git LFS server to use. Ignored if the `lfs.url` config key is set.
* `-f` `--force`:
Tells the server to remove the lock, even if it's owned by another user.
* `-i <id>` `--id=<id>`:
Specifies a lock by its ID instead of path.
* `--json`:
Writes lock info as JSON to STDOUT. Intended for interoperation with external
tools.
## SEE ALSO
git-lfs-lock(1), git-lfs-locks(1).
Part of the git-lfs(1) suite.