git-lfs/docs/man/git-lfs-pre-push.adoc
brian m. carlson 5c2ca772fb
docs/man: fix titles of AsciiDoc man pages
When pandoc did our conversion to AsciiDoc, it was not aware that we
were working with manual pages.  Automatic handling of manual pages with
Asciidoctor requires that the title of the manual page be a top-level,
not a second-level, title, and that the name section be explicitly
specified.

Let's fix our manual pages to meet that standard automatically with the
following shell command.  This has the pleasant side effect of also
normalizing whether we use one or two dashes between the name and the
description to a single dash, which is what the Git manual pages use.

  ruby -pi -e '$_.gsub!(/^(=+)=( \S)/, "\\1\\2")' \
  -e '$_.gsub!(/^= (\S+)(\(\d\)) -+ (.*)$/, "= \\1\\2\n\n== NAME\n\n\\1 - \\3")' \
  *.adoc
2022-06-23 16:25:13 +00:00

41 lines
866 B
Plaintext

= git-lfs-pre-push(1)
== NAME
git-lfs-pre-push - Git pre-push hook implementation
== SYNOPSIS
`git lfs pre-push` <remote> [remoteurl]
== DESCRIPTION
Responds to Git pre-hook events. It reads the range of commits from
STDIN, in the following format:
....
<local-ref> SP <local-sha1> SP <remote-ref> SP <remote-sha1> \n
....
It also takes the remote name and URL as arguments.
If any of those Git objects are associated with Git LFS objects, those
objects will be pushed to the Git LFS API.
In the case of pushing a new branch, the list of Git objects will be all
of the Git objects in this branch.
In the case of deleting a branch, no attempts to push Git LFS objects
will be made.
== OPTIONS
* `GIT_LFS_SKIP_PUSH`: Do nothing on pre-push. For more, see:
git-lfs-config(5).
== SEE ALSO
git-lfs-clean(1), git-lfs-push(1).
Part of the git-lfs(1) suite.