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

docs: add --to and related options to docs

Browse Source 
Document the --to, --base, --ours, and --theirs options to git lfs
checkout.  Since we're adding new functionality that isn't available by
other means, stop saying the command is deprecated.
This commit is contained in:
brian m. carlson 2018-10-02 14:43:00 +00:00
parent cf7f9678b3
commit 35ba22dfde
No known key found for this signature in database
GPG Key ID: 2D0C9BC12F82B3A1
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/man/git-lfs-checkout.1.ronn
View File

@ -4,14 +4,13 @@ git-lfs-checkout(1) -- Update working copy with file content if available
## SYNOPSIS
`git lfs checkout` <filespec>...
`git lfs checkout` --to <path> { --ours | --theirs | --base } <file>...
## DESCRIPTION
This command is deprecated, and should be replaced with `git checkout`.
Try to ensure that the working copy contains file content for Git LFS objects
for the current ref, if the object data is available. Does not download any
content, see git-lfs-fetch(1) for that.
content, see git-lfs-fetch(1) for that.
Checkout scans the current ref for all LFS objects that would be required, then
where a file is either missing in the working copy, or contains placeholder
@ -20,6 +19,28 @@ we have it in the local store. Modified files are never overwritten.
Filespecs can be provided as arguments to restrict the files which are updated.
When used with `--to` and the working tree is in a conflicted state due to a
merge, this option checks out one of the three stages of the conflict into a
separate file. This can make using diff tools to inspect and resolve merges
easier.
## OPTIONS
* `--base`:
Check out the merge base of the specified file.
* `--ours`:
Check out our side (that of the current branch) of the conflict for the
specified file.
* `--theirs`:
Check out their side (that of the other branch) of the conflict for the
specified file.
* `--to` <path>:
If the working tree is in a conflicted state, check out the portion of the
conflict specified by `--base`, `--ours`, or `--theirs` to the given path.
## EXAMPLES
* Checkout all files that are missing or placeholders