]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-update-index.txt
Docs: Use "-l::\n--long\n" format in OPTIONS sections
authorStephan Beyer <s-beyer@gmx.net>
Sun, 8 Jun 2008 01:36:09 +0000 (03:36 +0200)
committerJunio C Hamano <gitster@pobox.com>
Sun, 8 Jun 2008 20:46:38 +0000 (13:46 -0700)
commit3240240ff427fa2e26a847c7c9fd89e6a4313daa
treea1e21579aca42b7e4d8d718050bc522961530cfa
parentbc47c29ec18164ba1f05600333457cf6f2432856
Docs: Use "-l::\n--long\n" format in OPTIONS sections

The OPTIONS section of a documentation file contains a list
of the options a git command accepts.

Currently there are several variants to describe the case that
different options (almost) do the same in the OPTIONS section.

Some are:

 -f, --foo::
 -f|--foo::
 -f | --foo::

But AsciiDoc has the special form:

 -f::
 --foo::

This patch applies this form to the documentation of the whole git suite,
and removes useless em-dash prevention, so \--foo becomes --foo.

Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
56 files changed:
Documentation/blame-options.txt
Documentation/fetch-options.txt
Documentation/git-add.txt
Documentation/git-am.txt
Documentation/git-apply.txt
Documentation/git-archive.txt
Documentation/git-blame.txt
Documentation/git-branch.txt
Documentation/git-checkout-index.txt
Documentation/git-checkout.txt
Documentation/git-cherry-pick.txt
Documentation/git-commit.txt
Documentation/git-config.txt
Documentation/git-cvsserver.txt
Documentation/git-daemon.txt
Documentation/git-diff-files.txt
Documentation/git-fetch-pack.txt
Documentation/git-filter-branch.txt
Documentation/git-fmt-merge-msg.txt
Documentation/git-for-each-ref.txt
Documentation/git-format-patch.txt
Documentation/git-grep.txt
Documentation/git-help.txt
Documentation/git-http-push.txt
Documentation/git-init.txt
Documentation/git-instaweb.txt
Documentation/git-ls-files.txt
Documentation/git-ls-remote.txt
Documentation/git-mv.txt
Documentation/git-pack-objects.txt
Documentation/git-pack-refs.txt
Documentation/git-peek-remote.txt
Documentation/git-prune.txt
Documentation/git-pull.txt
Documentation/git-push.txt
Documentation/git-rebase.txt
Documentation/git-repack.txt
Documentation/git-rev-parse.txt
Documentation/git-revert.txt
Documentation/git-rm.txt
Documentation/git-send-email.txt
Documentation/git-send-pack.txt
Documentation/git-shortlog.txt
Documentation/git-show-branch.txt
Documentation/git-show-ref.txt
Documentation/git-stripspace.txt
Documentation/git-submodule.txt
Documentation/git-symbolic-ref.txt
Documentation/git-update-index.txt
Documentation/git-update-server-info.txt
Documentation/git-upload-pack.txt
Documentation/git-web--browse.txt
Documentation/git.txt
Documentation/gitk.txt
Documentation/merge-options.txt
Documentation/rev-list-options.txt