Skip to content

Commit 4e14058

Browse files
committed
doc: convert git-range-diff manual page to synopsis style
* convert commands and options to synopsis style * use _<placeholder>_ for arguments * small style fixes Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
1 parent f9d931d commit 4e14058

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

Documentation/git-range-diff.adoc

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ git-range-diff - Compare two commit ranges (e.g. two versions of a branch)
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git range-diff' [--color=[<when>]] [--no-color] [<diff-options>]
10+
[synopsis]
11+
git range-diff [--color=[<when>]] [--no-color] [<diff-options>]
1212
[--no-dual-color] [--creation-factor=<factor>]
1313
[--left-only | --right-only] [--diff-merges=<format>]
1414
[--remerge-diff]
@@ -21,14 +21,14 @@ DESCRIPTION
2121
This command shows the differences between two versions of a patch
2222
series, or more generally, two commit ranges (ignoring merge commits).
2323

24-
In the presence of `<path>` arguments, these commit ranges are limited
24+
In the presence of _<path>_ arguments, these commit ranges are limited
2525
accordingly.
2626

2727
To that end, it first finds pairs of commits from both commit ranges
2828
that correspond with each other. Two commits are said to correspond when
2929
the diff between their patches (i.e. the author information, the commit
3030
message and the commit diff) is reasonably small compared to the
31-
patches' size. See ``Algorithm`` below for details.
31+
patches' size. See 'Algorithm' below for details.
3232

3333
Finally, the list of matching commits is shown in the order of the
3434
second commit range, with unmatched commits being inserted just after
@@ -37,7 +37,7 @@ all of their ancestors have been shown.
3737
There are three ways to specify the commit ranges:
3838

3939
- `<range1> <range2>`: Either commit range can be of the form
40-
`<base>..<rev>`, `<rev>^!` or `<rev>^-<n>`. See `SPECIFYING RANGES`
40+
`<base>..<rev>`, `<rev>^!` or `<rev>^-<n>`. See 'SPECIFYING RANGES'
4141
in linkgit:gitrevisions[7] for more details.
4242
4343
- `<rev1>...<rev2>`. This is equivalent to
@@ -48,41 +48,41 @@ There are three ways to specify the commit ranges:
4848
4949
OPTIONS
5050
-------
51-
--no-dual-color::
51+
`--no-dual-color`::
5252
When the commit diffs differ, `git range-diff` recreates the
5353
original diffs' coloring, and adds outer -/+ diff markers with
5454
the *background* being red/green to make it easier to see e.g.
5555
when there was a change in what exact lines were added.
5656
+
5757
Additionally, the commit diff lines that are only present in the first commit
5858
range are shown "dimmed" (this can be overridden using the `color.diff.<slot>`
59-
config setting where `<slot>` is one of `contextDimmed`, `oldDimmed` and
59+
config setting where _<slot>_ is one of `contextDimmed`, `oldDimmed` and
6060
`newDimmed`), and the commit diff lines that are only present in the second
6161
commit range are shown in bold (which can be overridden using the config
62-
settings `color.diff.<slot>` with `<slot>` being one of `contextBold`,
62+
settings `color.diff.<slot>` with _<slot>_ being one of `contextBold`,
6363
`oldBold` or `newBold`).
6464
+
6565
This is known to `range-diff` as "dual coloring". Use `--no-dual-color`
6666
to revert to color all lines according to the outer diff markers
6767
(and completely ignore the inner diff when it comes to color).
6868

69-
--creation-factor=<percent>::
70-
Set the creation/deletion cost fudge factor to `<percent>`.
69+
`--creation-factor=<percent>`::
70+
Set the creation/deletion cost fudge factor to _<percent>_.
7171
Defaults to 60. Try a larger value if `git range-diff` erroneously
7272
considers a large change a total rewrite (deletion of one commit
7373
and addition of another), and a smaller one in the reverse case.
74-
See the ``Algorithm`` section below for an explanation of why this is
74+
See the 'Algorithm' section below for an explanation of why this is
7575
needed.
7676

77-
--left-only::
77+
`--left-only`::
7878
Suppress commits that are missing from the first specified range
79-
(or the "left range" when using the `<rev1>...<rev2>` format).
79+
(or the "left range" when using the `<rev1>...<rev2>` form).
8080

81-
--right-only::
81+
`--right-only`::
8282
Suppress commits that are missing from the second specified range
83-
(or the "right range" when using the `<rev1>...<rev2>` format).
83+
(or the "right range" when using the `<rev1>...<rev2>` form).
8484

85-
--diff-merges=<format>::
85+
`--diff-merges=<format>`::
8686
Instead of ignoring merge commits, generate diffs for them using the
8787
corresponding `--diff-merges=<format>` option of linkgit:git-log[1],
8888
and include them in the comparison.
@@ -93,30 +93,30 @@ have produced. In other words, if a merge commit is the result of a
9393
non-conflicting `git merge`, the `remerge` mode will represent it with an empty
9494
diff.
9595

96-
--remerge-diff::
96+
`--remerge-diff`::
9797
Convenience option, equivalent to `--diff-merges=remerge`.
9898

99-
--notes[=<ref>]::
100-
--no-notes::
99+
`--notes[=<ref>]`::
100+
`--no-notes`::
101101
This flag is passed to the `git log` program
102102
(see linkgit:git-log[1]) that generates the patches.
103103

104-
<range1> <range2>::
104+
`<range1> <range2>`::
105105
Compare the commits specified by the two ranges, where
106-
`<range1>` is considered an older version of `<range2>`.
106+
_<range1>_ is considered an older version of _<range2>_.
107107

108-
<rev1>...<rev2>::
108+
`<rev1>...<rev2>`::
109109
Equivalent to passing `<rev2>..<rev1>` and `<rev1>..<rev2>`.
110110

111-
<base> <rev1> <rev2>::
111+
`<base> <rev1> <rev2>`::
112112
Equivalent to passing `<base>..<rev1>` and `<base>..<rev2>`.
113-
Note that `<base>` does not need to be the exact branch point
113+
Note that _<base>_ does not need to be the exact branch point
114114
of the branches. Example: after rebasing a branch `my-topic`,
115115
`git range-diff my-topic@{u} my-topic@{1} my-topic` would
116116
show the differences introduced by the rebase.
117117

118118
`git range-diff` also accepts the regular diff options (see
119-
linkgit:git-diff[1]), most notably the `--color=[<when>]` and
119+
linkgit:git-diff[1]), most notably the `--color[=<when>]` and
120120
`--no-color` options. These options are used when generating the "diff
121121
between patches", i.e. to compare the author, commit message and diff of
122122
corresponding old/new commits. There is currently no means to tweak most of the

0 commit comments

Comments
 (0)