From 3240240ff427fa2e26a847c7c9fd89e6a4313daa Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Sun, 8 Jun 2008 03:36:09 +0200 Subject: 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 Signed-off-by: Junio C Hamano --- Documentation/git-help.txt | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'Documentation/git-help.txt') diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 8994c6d434..faecd6bb90 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -28,15 +28,18 @@ former is internally converted into the latter. OPTIONS ------- --a|--all:: +-a:: +--all:: Prints all the available commands on the standard output. This option supersedes any other option. --i|--info:: +-i:: +--info:: Display manual page for the command in the 'info' format. The 'info' program will be used for that purpose. --m|--man:: +-m:: +--man:: Display manual page for the command in the 'man' format. This option may be used to override a value set in the 'help.format' configuration variable. @@ -45,7 +48,8 @@ By default the 'man' program will be used to display the manual page, but the 'man.viewer' configuration variable may be used to choose other display programs (see below). --w|--web:: +-w:: +--web:: Display manual page for the command in the 'web' (HTML) format. A web browser will be used for that purpose. + -- cgit v1.3-5-g45d5