diff options
| author | Martin von Zweigbergk <martin.von.zweigbergk@gmail.com> | 2011-07-01 22:38:26 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-07-06 14:26:26 -0700 |
| commit | 7791a1d9b9a4f4e15662c7c9c7f5837f461bb987 (patch) | |
| tree | 92fee8b0a3cd778930daeef31be7c2dceeb1b905 /contrib | |
| parent | f696543dad6c7ba27b0c4fab167a5687263a9ba0 (diff) | |
| download | git-7791a1d9b9a4f4e15662c7c9c7f5837f461bb987.tar.gz | |
Documentation: use [verse] for SYNOPSIS sections
The SYNOPSIS sections of most commands that span several lines already
use [verse] to retain line breaks. Most commands that don't span
several lines seem not to use [verse]. In the HTML output, [verse]
does not only preserve line breaks, but also makes the section
indented, which causes a slight inconsistency between commands that
use [verse] and those that don't. Use [verse] in all SYNOPSIS sections
for consistency.
Also remove the blank lines from git-fetch.txt and git-rebase.txt to
align with the other man pages. In the case of git-rebase.txt, which
already uses [verse], the blank line makes the [verse] not apply to
the last line, so removing the blank line also makes the formatting
within the document more consistent.
While at it, add single quotes to 'git cvsimport' for consistency with
other commands.
Signed-off-by: Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'contrib')
| -rw-r--r-- | contrib/convert-objects/git-convert-objects.txt | 1 | ||||
| -rw-r--r-- | contrib/gitview/gitview.txt | 1 | ||||
| -rw-r--r-- | contrib/svn-fe/svn-fe.txt | 1 |
3 files changed, 3 insertions, 0 deletions
diff --git a/contrib/convert-objects/git-convert-objects.txt b/contrib/convert-objects/git-convert-objects.txt index 9718abf86d..0565d83fc4 100644 --- a/contrib/convert-objects/git-convert-objects.txt +++ b/contrib/convert-objects/git-convert-objects.txt @@ -8,6 +8,7 @@ git-convert-objects - Converts old-style git repository SYNOPSIS -------- +[verse] 'git-convert-objects' DESCRIPTION diff --git a/contrib/gitview/gitview.txt b/contrib/gitview/gitview.txt index 77c29de305..9e12f97842 100644 --- a/contrib/gitview/gitview.txt +++ b/contrib/gitview/gitview.txt @@ -7,6 +7,7 @@ gitview - A GTK based repository browser for git SYNOPSIS -------- +[verse] 'gitview' [options] [args] DESCRIPTION diff --git a/contrib/svn-fe/svn-fe.txt b/contrib/svn-fe/svn-fe.txt index cd075b96c5..72ffea0b3a 100644 --- a/contrib/svn-fe/svn-fe.txt +++ b/contrib/svn-fe/svn-fe.txt @@ -7,6 +7,7 @@ svn-fe - convert an SVN "dumpfile" to a fast-import stream SYNOPSIS -------- +[verse] svnadmin dump --incremental REPO | svn-fe [url] | git fast-import DESCRIPTION |