Skip to content

Commit 7791a1d

Browse files
Martin von Zweigbergkgitster
Martin von Zweigbergk
authored and
gitster
committed
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent f696543 commit 7791a1d

File tree

93 files changed

+92
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+92
-6
lines changed

‎Documentation/git-annotate.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ git-annotate - Annotate file lines with commit information
77

88
SYNOPSIS
99
--------
10+
[verse]
1011
'git annotate' [options] file [revision]
1112

1213
DESCRIPTION

‎Documentation/git-bisect.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ git-bisect - Find by binary search the change that introduced a bug
88

99
SYNOPSIS
1010
--------
11+
[verse]
1112
'git bisect' <subcommand> <options>
1213

1314
DESCRIPTION

‎Documentation/git-cherry-pick.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
77

88
SYNOPSIS
99
--------
10+
[verse]
1011
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff] <commit>...
1112

1213
DESCRIPTION

‎Documentation/git-cherry.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ git-cherry - Find commits not merged upstream
77

88
SYNOPSIS
99
--------
10+
[verse]
1011
'git cherry' [-v] [<upstream> [<head> [<limit>]]]
1112

1213
DESCRIPTION

‎Documentation/git-citool.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ git-citool - Graphical alternative to git-commit
77

88
SYNOPSIS
99
--------
10+
[verse]
1011
'git citool'
1112

1213
DESCRIPTION

‎Documentation/git-commit-tree.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ git-commit-tree - Create a new commit object
88

99
SYNOPSIS
1010
--------
11+
[verse]
1112
'git commit-tree' <tree> [(-p <parent commit>)...] < changelog
1213

1314
DESCRIPTION

‎Documentation/git-count-objects.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ git-count-objects - Count unpacked number of objects and their disk consumption
77

88
SYNOPSIS
99
--------
10+
[verse]
1011
'git count-objects' [-v]
1112

1213
DESCRIPTION

‎Documentation/git-cvsexportcommit.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
88

99
SYNOPSIS
1010
--------
11+
[verse]
1112
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
1213
[-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID
1314

‎Documentation/git-diff-files.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ git-diff-files - Compares files in the working tree and the index
88

99
SYNOPSIS
1010
--------
11+
[verse]
1112
'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
1213

1314
DESCRIPTION

‎Documentation/git-diff-index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ git-diff-index - Compares content and mode of blobs between the index and reposi
88

99
SYNOPSIS
1010
--------
11+
[verse]
1112
'git diff-index' [-m] [--cached] [<common diff options>] <tree-ish> [<path>...]
1213

1314
DESCRIPTION

0 commit comments

Comments
 (0)