git-lfs/docs/man/git-lfs-clean.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

29 lines
652 B
Plaintext

= git-lfs-clean(1)
== NAME
git-lfs-clean - Git clean filter that converts large files to pointers
== SYNOPSIS
`git lfs clean` <path>
== DESCRIPTION
Read the contents of a large file from standard input, and write a Git
LFS pointer file for that file to standard output.
Clean is typically run by Git's clean filter, configured by the
repository's Git attributes.
Clean is not part of the user-facing Git plumbing commands. To preview
the pointer of a large file as it would be generated, see the
git-lfs-pointer(1) command.
== SEE ALSO
git-lfs-install(1), git-lfs-push(1), git-lfs-pointer(1),
gitattributes(5).
Part of the git-lfs(1) suite.