lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc updates

Browse Source
This commit is contained in:
risk danger olson 2017-02-15 13:38:47 -07:00
parent 5b40436a9b
commit 0bb4697cc0
4 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/man/git-lfs-config.5.ronn
View File

@ -184,7 +184,7 @@ 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`
* `lfs.<url>.locksverify`
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
@ -199,6 +199,8 @@ lfs option can be scoped inside the configuration for a remote.
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.
You should set this if you're not using File Locking, or your Git server
verifies locked files on pushes automatically.
* `lfs.skipdownloaderrors`

9
docs/man/git-lfs-lock.1.ronn
View File

@ -11,14 +11,19 @@ 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. Locking
a file requires the file to exist in the working copy.
Once locked, LFS will verify that Git pushes do not modify files locked by
other users. See the description of the `lfs.<url>.locksverify` config key in
git-lfs-config(5) for details.
## 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.
Writes lock info as JSON to STDOUT if the command exits successfully. Intended
for interoperation with external tools. If the command returns with a non-zero
exit code, plain text messages will be sent to STDERR.
## SEE ALSO

9
docs/man/git-lfs-locks.1.ronn
View File

@ -15,10 +15,10 @@ Lists current locks from the Git LFS server.
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.
Specifies a lock by its ID. Returns a single result.
* `-p <path>` `--path=<path>`:
Specifies a lock by its path.
Specifies a lock by its path. Returns a single result.
* `--local`:
Lists only the locks cached locally. Skips a remote call.
@ -27,8 +27,9 @@ Lists current locks from the Git LFS server.
Specifies number of results to return.
* `--json`:
Writes lock info as JSON to STDOUT. Intended for interoperation with external
tools.
Writes lock info as JSON to STDOUT if the command exits successfully. Intended
for interoperation with external tools. If the command returns with a non-zero
exit code, plain text messages will be sent to STDERR.
## SEE ALSO

7
docs/man/git-lfs-unlock.1.ronn
View File

@ -3,7 +3,7 @@ git-lfs-unlock(1) -- Remove "locked" setting for a file on the Git LFS server
## SYNOPSIS
`git lfs unlock` [options] <path>
`git lfs unlock` [OPTIONS] <path>
## DESCRIPTION
@ -23,8 +23,9 @@ skip these checks.
Specifies a lock by its ID instead of path.
* `--json`:
Writes lock info as JSON to STDOUT. Intended for interoperation with external
tools.
Writes lock info as JSON to STDOUT if the command exits successfully. Intended
for interoperation with external tools. If the command returns with a non-zero
exit code, plain text messages will be sent to STDERR.
## SEE ALSO