Skip to content

Commit 5004a62

Browse files
committed
doc: git-log: convert pretty options to new doc format
- Use _<placeholder>_ instead of <placeholder> in the description - Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. Signed-off-by: Jean-Noël Avila <[email protected]>
1 parent 71d9a37 commit 5004a62

File tree

1 file changed

+36
-35
lines changed

1 file changed

+36
-35
lines changed

Documentation/pretty-options.adoc

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
1-
--pretty[=<format>]::
2-
--format=<format>::
1+
`--pretty[=<format>]`::
2+
`--format=<format>`::
33

44
Pretty-print the contents of the commit logs in a given format,
5-
where '<format>' can be one of 'oneline', 'short', 'medium',
6-
'full', 'fuller', 'reference', 'email', 'raw', 'format:<string>'
7-
and 'tformat:<string>'. When '<format>' is none of the above,
8-
and has '%placeholder' in it, it acts as if
9-
'--pretty=tformat:<format>' were given.
5+
where '<format>' can be one of `oneline`, `short`, `medium`,
6+
`full`, `fuller`, `reference`, `email`, `raw`, `format:<string>`
7+
and `tformat:<string>`. When _<format>_ is none of the above,
8+
and has `%<placeholder>` in it, it acts as if
9+
`--pretty=tformat:<format>` were given.
1010
+
1111
See the "PRETTY FORMATS" section for some additional details for each
12-
format. When '=<format>' part is omitted, it defaults to 'medium'.
12+
format. When `=<format>` part is omitted, it defaults to `medium.
1313
+
14-
Note: you can specify the default pretty format in the repository
14+
NOTE: you can specify the default pretty format in the repository
1515
configuration (see linkgit:git-config[1]).
1616

17-
--abbrev-commit::
17+
`--abbrev-commit`::
1818
Instead of showing the full 40-byte hexadecimal commit object
1919
name, show a prefix that names the object uniquely.
20-
"--abbrev=<n>" (which also modifies diff output, if it is displayed)
20+
`--abbrev=<n>` (which also modifies diff output, if it is displayed)
2121
option can be used to specify the minimum length of the prefix.
2222
+
23-
This should make "--pretty=oneline" a whole lot more readable for
23+
This should make `--pretty=oneline` a whole lot more readable for
2424
people using 80-column terminals.
2525

26-
--no-abbrev-commit::
26+
`--no-abbrev-commit`::
2727
Show the full 40-byte hexadecimal commit object name. This negates
2828
`--abbrev-commit`, either explicit or implied by other options such
29-
as "--oneline". It also overrides the `log.abbrevCommit` variable.
29+
as `--oneline`. It also overrides the `log.abbrevCommit` variable.
3030

31-
--oneline::
32-
This is a shorthand for "--pretty=oneline --abbrev-commit"
31+
`--oneline`::
32+
This is a shorthand for `--pretty=oneline --abbrev-commit`
3333
used together.
3434

35-
--encoding=<encoding>::
35+
`--encoding=<encoding>`::
3636
Commit objects record the character encoding used for the log message
3737
in their encoding header; this option can be used to tell the
3838
command to re-code the commit log message in the encoding
@@ -44,22 +44,22 @@ people using 80-column terminals.
4444
to convert the commit, we will quietly output the original
4545
object verbatim.
4646

47-
--expand-tabs=<n>::
48-
--expand-tabs::
49-
--no-expand-tabs::
47+
`--expand-tabs=<n>`::
48+
`--expand-tabs`::
49+
`--no-expand-tabs`::
5050
Perform a tab expansion (replace each tab with enough spaces
51-
to fill to the next display column that is a multiple of '<n>')
51+
to fill to the next display column that is a multiple of _<n>_)
5252
in the log message before showing it in the output.
5353
`--expand-tabs` is a short-hand for `--expand-tabs=8`, and
5454
`--no-expand-tabs` is a short-hand for `--expand-tabs=0`,
5555
which disables tab expansion.
5656
+
5757
By default, tabs are expanded in pretty formats that indent the log
58-
message by 4 spaces (i.e. 'medium', which is the default, 'full',
59-
and 'fuller').
58+
message by 4 spaces (i.e. `medium`, which is the default, `full`,
59+
and `fuller`).
6060

6161
ifndef::git-rev-list[]
62-
--notes[=<ref>]::
62+
`--notes[=<ref>]`::
6363
Show the notes (see linkgit:git-notes[1]) that annotate the
6464
commit, when showing the commit log message. This is the default
6565
for `git log`, `git show` and `git whatchanged` commands when
@@ -75,28 +75,29 @@ to display. The ref can specify the full refname when it begins
7575
with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise
7676
`refs/notes/` is prefixed to form the full name of the ref.
7777
+
78-
Multiple --notes options can be combined to control which notes are
79-
being displayed. Examples: "--notes=foo" will show only notes from
80-
"refs/notes/foo"; "--notes=foo --notes" will show both notes from
78+
Multiple `--notes` options can be combined to control which notes are
79+
being displayed. Examples: "`--notes=foo`" will show only notes from
80+
`refs/notes/foo`; "`--notes=foo --notes`" will show both notes from
8181
"refs/notes/foo" and from the default notes ref(s).
8282

83-
--no-notes::
83+
`--no-notes`::
8484
Do not show notes. This negates the above `--notes` option, by
8585
resetting the list of notes refs from which notes are shown.
8686
Options are parsed in the order given on the command line, so e.g.
87-
"--notes --notes=foo --no-notes --notes=bar" will only show notes
88-
from "refs/notes/bar".
87+
"`--notes --notes=foo --no-notes --notes=bar`" will only show notes
88+
from `refs/notes/bar`.
8989

90-
--show-notes-by-default::
90+
`--show-notes-by-default`::
9191
Show the default notes unless options for displaying specific
9292
notes are given.
9393

94-
--show-notes[=<ref>]::
95-
--[no-]standard-notes::
96-
These options are deprecated. Use the above --notes/--no-notes
94+
`--show-notes[=<ref>]`::
95+
`--standard-notes`::
96+
`--no-standard-notes`::
97+
These options are deprecated. Use the above `--notes`/`--no-notes`
9798
options instead.
9899
endif::git-rev-list[]
99100

100-
--show-signature::
101+
`--show-signature`::
101102
Check the validity of a signed commit object by passing the signature
102103
to `gpg --verify` and show the output.

0 commit comments

Comments
 (0)