Skip to content

Commit 5c20164

Browse files
committed
doc: convert git-shortlog 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 4e14058 commit 5c20164

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

Documentation/git-shortlog.adoc

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,63 +3,63 @@ git-shortlog(1)
33

44
NAME
55
----
6-
git-shortlog - Summarize 'git log' output
6+
git-shortlog - Summarize `git log` output
77

88
SYNOPSIS
99
--------
10-
[verse]
11-
'git shortlog' [<options>] [<revision-range>] [[--] <path>...]
12-
git log --pretty=short | 'git shortlog' [<options>]
10+
[synopsis]
11+
git shortlog [<options>] [<revision-range>] [[--] <path>...]
12+
git log --pretty=short | git shortlog [<options>]
1313

1414
DESCRIPTION
1515
-----------
16-
Summarizes 'git log' output in a format suitable for inclusion
16+
Summarizes `git log` output in a format suitable for inclusion
1717
in release announcements. Each commit will be grouped by author and title.
1818

1919
Additionally, "[PATCH]" will be stripped from the commit description.
2020

2121
If no revisions are passed on the command line and either standard input
22-
is not a terminal or there is no current branch, 'git shortlog' will
22+
is not a terminal or there is no current branch, `git shortlog` will
2323
output a summary of the log read from standard input, without
2424
reference to the current repository.
2525

2626
OPTIONS
2727
-------
2828

29-
-n::
30-
--numbered::
29+
`-n`::
30+
`--numbered`::
3131
Sort output according to the number of commits per author instead
3232
of author alphabetic order.
3333

34-
-s::
35-
--summary::
34+
`-s`::
35+
`--summary`::
3636
Suppress commit description and provide a commit count summary only.
3737

38-
-e::
39-
--email::
38+
`-e`::
39+
`--email`::
4040
Show the email address of each author.
4141

42-
--format[=<format>]::
42+
`--format[=<format>]`::
4343
Instead of the commit subject, use some other information to
44-
describe each commit. '<format>' can be any string accepted
45-
by the `--format` option of 'git log', such as '* [%h] %s'.
46-
(See the "PRETTY FORMATS" section of linkgit:git-log[1].)
44+
describe each commit. _<format>_ can be any string accepted
45+
by the `--format` option of `git log`, such as '* [%h] %s'.
46+
(See the 'PRETTY FORMATS' section of linkgit:git-log[1].)
4747
+
4848
Each pretty-printed commit will be rewrapped before it is shown.
4949

50-
--date=<format>::
50+
`--date=<format>`::
5151
Show dates formatted according to the given date string. (See
52-
the `--date` option in the "Commit Formatting" section of
52+
the `--date` option in the 'Commit Formatting' section of
5353
linkgit:git-log[1]). Useful with `--group=format:<format>`.
5454

55-
--group=<type>::
56-
Group commits based on `<type>`. If no `--group` option is
57-
specified, the default is `author`. `<type>` is one of:
55+
`--group=<type>`::
56+
Group commits based on _<type>_. If no `--group` option is
57+
specified, the default is `author`. _<type>_ is one of:
5858
+
5959
--
6060
- `author`, commits are grouped by author
6161
- `committer`, commits are grouped by committer (the same as `-c`)
62-
- `trailer:<field>`, the `<field>` is interpreted as a case-insensitive
62+
- `trailer:<field>`, the _<field>_ is interpreted as a case-insensitive
6363
commit message trailer (see linkgit:git-interpret-trailers[1]). For
6464
example, if your project uses `Reviewed-by` trailers, you might want
6565
to see who has been reviewing with
@@ -76,7 +76,7 @@ unless the `--email` option is specified. If the value cannot be parsed
7676
as an identity, it will be taken literally and completely.
7777

7878
- `format:<format>`, any string accepted by the `--format` option of
79-
'git log'. (See the "PRETTY FORMATS" section of
79+
`git log`. (See the 'PRETTY FORMATS' section of
8080
linkgit:git-log[1].)
8181
--
8282
+
@@ -85,11 +85,11 @@ value (but again, only once per unique value in that commit). For
8585
example, `git shortlog --group=author --group=trailer:co-authored-by`
8686
counts both authors and co-authors.
8787

88-
-c::
89-
--committer::
88+
`-c`::
89+
`--committer`::
9090
This is an alias for `--group=committer`.
9191

92-
-w[<width>[,<indent1>[,<indent2>]]]::
92+
`-w[<width>[,<indent1>[,<indent2>]]]`::
9393
Linewrap the output by wrapping each line at `width`. The first
9494
line of each entry is indented by `indent1` spaces, and the second
9595
and subsequent lines are indented by `indent2` spaces. `width`,
@@ -98,16 +98,16 @@ counts both authors and co-authors.
9898
If width is `0` (zero) then indent the lines of the output without wrapping
9999
them.
100100

101-
<revision-range>::
101+
`<revision-range>`::
102102
Show only commits in the specified revision range. When no
103-
<revision-range> is specified, it defaults to `HEAD` (i.e. the
103+
_<revision-range>_ is specified, it defaults to `HEAD` (i.e. the
104104
whole history leading to the current commit). `origin..HEAD`
105105
specifies all the commits reachable from the current commit
106106
(i.e. `HEAD`), but not from `origin`. For a complete list of
107-
ways to spell <revision-range>, see the "Specifying Ranges"
107+
ways to spell _<revision-range>_, see the 'Specifying Ranges'
108108
section of linkgit:gitrevisions[7].
109109

110-
[--] <path>...::
110+
`[--] <path>...`::
111111
Consider only commits that are enough to explain how the files
112112
that match the specified paths came to be.
113113
+

0 commit comments

Comments
 (0)