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

Man pages: change command descriptions to the imperative voice

Browse Source
This commit is contained in:
Michael Haggerty 2015-04-11 09:02:18 +02:00
parent ac1451ed52
commit e151e9828a
10 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/man/git-lfs-clean.1.ronn
View File

@ -7,8 +7,8 @@ git-lfs-clean(1) -- Git clean filter that converts large files to pointers
## DESCRIPTION
Clean calculates a SHA-256 signature of the data from STDOUT, and outputs a
Git LFS pointer file. It also queues the file to be pushed by
Calculate a SHA-256 signature of the data from STDOUT, and output a
Git LFS pointer file. Also queue the file to be pushed by
git-lfs-push(1).
Clean is typically run by Git's clean filter, configured by the repository's

2
docs/man/git-lfs-env.1.ronn
View File

@ -7,7 +7,7 @@ git-lfs-env(1) -- Display the Git LFS environment
## DESCRIPTION
Displays the current Git LFS environment.
Display the current Git LFS environment.
## SEE ALSO

6
docs/man/git-lfs-init.1.ronn
View File

@ -7,10 +7,10 @@ git-lfs-init(1) -- Ensure Git LFS is configured properly
## DESCRIPTION
Init performs the following actions to ensure Git LFS is setup properly:
Perform the following actions to ensure that Git LFS is setup properly:
* Sets up the clean and smudge filters under the name "lfs".
* Installs a pre-push hook to run git-lfs-push(1)
* Set up the clean and smudge filters under the name "lfs".
* Install a pre-push hook to run git-lfs-push(1)
## SEE ALSO

4
docs/man/git-lfs-logs.1.ronn
View File

@ -10,12 +10,12 @@ git-lfs-logs(1) - Show errors from the git-lfs command
## DESCRIPTION
The "logs" command displays errors from the git-lfs command. Any time it
Display errors from the git-lfs command. Any time it
crashes, the details are saved to ".git/lfs/logs".
## OPTIONS
Without any options, `git lfs logs` will simply show the list of error logs.
Without any options, `git lfs logs` simply shows the list of error logs.
* <file>:
Shows the specified error log. Use "last" to show the most recent error.

4
docs/man/git-lfs-ls-files.1.ronn
View File

@ -7,8 +7,8 @@ git-lfs-ls-files(1) -- Show information about git lfs files in the index and wor
## DESCRIPTION
Displays paths of Git LFS files that are found in the refspec. If no refspec is given,
the current checked out branch will be scanned.
Display paths of Git LFS files that are found in the refspec. If no refspec is given,
scan the currently checked-out branch.
## SEE ALSO

6
docs/man/git-lfs-push.1.ronn
View File

@ -7,7 +7,7 @@ git-lfs-push(1) -- Push queued large files to the Git LFS endpoint
## DESCRIPTION
Push uploads Git LFS files to the configured endpoint for the current
Upload Git LFS files to the configured endpoint for the current
Git remote.
Push is typically run by Git's pre-push hook.
@ -15,13 +15,13 @@ Push is typically run by Git's pre-push hook.
## OPTIONS
* `--dry-run`:
Prints the files that would be pushed, without actually pushing them.
Print the files that would be pushed, without actually pushing them.
* `--stdin`:
Read the repo and refspec on stdin. This is used in conjunction with
the pre-push hook and must be in the format used by the pre-push hook:
<local ref> <local sha1> <remote ref> <remote sha1>. If --stdin is used
the command line arguments will be ignored.
the command line arguments are ignored.
## SEE ALSO

10
docs/man/git-lfs-smudge.1.ronn
View File

@ -7,8 +7,8 @@ git-lfs-smudge(1) -- Git smudge filter that converts pointer in blobs to the act
## DESCRIPTION
Smudge takes a Git LFS pointer file in STDIN, parses out the pointer's ID,
and then dumps the file's contents to STDOUT. The file will be downloaded from
Read a Git LFS pointer file from STDIN, parse out the pointer's ID,
and then dump the file's contents to STDOUT. Download the file from
the Git LFS endpoint if needed. The optional <path> argument is only used for
a progress bar.
@ -17,12 +17,12 @@ Git attributes.
## OPTIONS
Without any options, `git lfs smudge` will output the raw Git LFS content to
Without any options, `git lfs smudge` outputs the raw Git LFS content to
STDOUT.
* `--info`:
Displays the file size, and the local path to the Git LFS file. If the file
does not exist, `--` is shown.
Display the file size and the local path to the Git LFS file. If the file
does not exist, show `--`.
## SEE ALSO

2
docs/man/git-lfs-status.1.ronn
View File

@ -7,7 +7,7 @@ git-lfs-status(1) -- Show the status of Git LFS files in the working tree
## DESCRIPTION
Displays paths of Git LFS objects that have not been pushed to the Git LFS
Display paths of Git LFS objects that have not been pushed to the Git LFS
server, have differences between the index file and the current HEAD commit,
and paths that have differences between the working tree and the index file.
Thi first are what you would push by running git push; the second are what

6
docs/man/git-lfs-track.1.ronn
View File

@ -7,9 +7,9 @@ git-lfs-track(1) - View or add Git LFS paths to Git attributes
## DESCRIPTION
The "track" command starts the given path(s) through Git LFS. The "path" \
argument can be a file extension, or a file path. If no paths are provided,
this will simply list the tracked paths.
Start tracking the given path(s) through Git LFS. The "path"
argument can be a file extension or a file path. If no paths are provided,
simply list the tracked paths.
## EXAMPLES

2
docs/man/git-lfs-untrack.1.ronn
View File

@ -7,7 +7,7 @@ git-lfs-untrack(1) - Remove Git LFS paths from Git Attributes
## DESCRIPTION
The "untrack" command stops tracking the given path(s) through Git LFS. The
Stop tracking the given path(s) through Git LFS. The
"path" argument can be a file extension, or a file path.
## EXAMPLES