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 <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Jul 7, 2025 at 18:53 UTC
06db6a3c4a9e23e575f9e5e7f812358deaf11834
1 file changed
+36
-35
Documentation/pretty-options.adoc
+36
-35
@@ -1,38 +1,38 @@
1
---pretty[=<format>]::
2
---format=<format>::
1
+`--pretty[=<format>]`::
2
+`--format=<format>`::
3
4
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.
10
+
11
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`.
13
+
14
-Note: you can specify the default pretty format in the repository
14
+NOTE: you can specify the default pretty format in the repository
15
configuration (see linkgit:git-config[1]).
16
17
---abbrev-commit::
17
+`--abbrev-commit`::
18
Instead of showing the full 40-byte hexadecimal commit object
19
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)
21
option can be used to specify the minimum length of the prefix.
22
+
23
-This should make "--pretty=oneline" a whole lot more readable for
23
+This should make `--pretty=oneline` a whole lot more readable for
24
people using 80-column terminals.
25
26
---no-abbrev-commit::
26
+`--no-abbrev-commit`::
27
Show the full 40-byte hexadecimal commit object name. This negates
28
`--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.
30
31
---oneline::
32
- This is a shorthand for "--pretty=oneline --abbrev-commit"
31
+`--oneline`::
32
+ This is a shorthand for `--pretty=oneline --abbrev-commit`
33
used together.
34
35
---encoding=<encoding>::
35
+`--encoding=<encoding>`::
36
Commit objects record the character encoding used for the log message
37
in their encoding header; this option can be used to tell the
38
command to re-code the commit log message in the encoding
@@ -44,22 +44,22 @@ people using 80-column terminals.
44
to convert the commit, we will quietly output the original
45
object verbatim.
46
47
---expand-tabs=<n>::
48
---expand-tabs::
49
---no-expand-tabs::
47
+`--expand-tabs=<n>`::
48
+`--expand-tabs`::
49
+`--no-expand-tabs`::
50
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>_)
52
in the log message before showing it in the output.
53
`--expand-tabs` is a short-hand for `--expand-tabs=8`, and
54
`--no-expand-tabs` is a short-hand for `--expand-tabs=0`,
55
which disables tab expansion.
56
+
57
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`).
60
61
ifndef::git-rev-list[]
62
---notes[=<ref>]::
62
+`--notes[=<ref>]`::
63
Show the notes (see linkgit:git-notes[1]) that annotate the
64
commit, when showing the commit log message. This is the default
65
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
75
with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise
76
`refs/notes/` is prefixed to form the full name of the ref.
77
+
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
81
"refs/notes/foo" and from the default notes ref(s).
82
83
---no-notes::
83
+`--no-notes`::
84
Do not show notes. This negates the above `--notes` option, by
85
resetting the list of notes refs from which notes are shown.
86
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`.
89
90
---show-notes-by-default::
90
+`--show-notes-by-default`::
91
Show the default notes unless options for displaying specific
92
notes are given.
93
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`
98
options instead.
99
endif::git-rev-list[]
100
100
---show-signature::
101
+`--show-signature`::
102
Check the validity of a signed commit object by passing the signature
103
to `gpg --verify` and show the output.