Skip to content

Commit e9493c5

Browse files
pks-tgitster
authored andcommitted
Documentation/git-reflog: convert to use synopsis type
With 974cdca (doc: introduce a synopsis typesetting, 2024-09-24) we have introduced a new synopsis type that simplifies the rules for typesetting a command's synopsis. Convert the git-reflog(1) documentation to use it. While at it, convert the list of options to use backticks. This is done to appease an upcoming new linter that mandates the use of backticks when using the synopsis type. Signed-off-by: Patrick Steinhardt <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d82adb6 commit e9493c5

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

Documentation/git-reflog.adoc

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ git-reflog - Manage reflog information
88

99
SYNOPSIS
1010
--------
11-
[verse]
12-
'git reflog' [show] [<log-options>] [<ref>]
13-
'git reflog list'
14-
'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>]
11+
[synopsis]
12+
git reflog [show] [<log-options>] [<ref>]
13+
git reflog list
14+
git reflog expire [--expire=<time>] [--expire-unreachable=<time>]
1515
[--rewrite] [--updateref] [--stale-fix]
1616
[--dry-run | -n] [--verbose] [--all [--single-worktree] | <refs>...]
17-
'git reflog delete' [--rewrite] [--updateref]
17+
git reflog delete [--rewrite] [--updateref]
1818
[--dry-run | -n] [--verbose] <ref>@{<specifier>}...
19-
'git reflog drop' [--all [--single-worktree] | <refs>...]
20-
'git reflog exists' <ref>
19+
git reflog drop [--all [--single-worktree] | <refs>...]
20+
git reflog exists <ref>
2121

2222
DESCRIPTION
2323
-----------
@@ -74,23 +74,23 @@ Options for `show`
7474
Options for `expire`
7575
~~~~~~~~~~~~~~~~~~~~
7676

77-
--all::
77+
`--all`::
7878
Process the reflogs of all references.
7979

80-
--single-worktree::
80+
`--single-worktree`::
8181
By default when `--all` is specified, reflogs from all working
8282
trees are processed. This option limits the processing to reflogs
8383
from the current working tree only.
8484

85-
--expire=<time>::
85+
`--expire=<time>`::
8686
Prune entries older than the specified time. If this option is
8787
not specified, the expiration time is taken from the
8888
configuration setting `gc.reflogExpire`, which in turn
8989
defaults to 90 days. `--expire=all` prunes entries regardless
9090
of their age; `--expire=never` turns off pruning of reachable
9191
entries (but see `--expire-unreachable`).
9292

93-
--expire-unreachable=<time>::
93+
`--expire-unreachable=<time>`::
9494
Prune entries older than `<time>` that are not reachable from
9595
the current tip of the branch. If this option is not
9696
specified, the expiration time is taken from the configuration
@@ -100,17 +100,17 @@ Options for `expire`
100100
turns off early pruning of unreachable entries (but see
101101
`--expire`).
102102

103-
--updateref::
103+
`--updateref`::
104104
Update the reference to the value of the top reflog entry (i.e.
105105
<ref>@\{0\}) if the previous top entry was pruned. (This
106106
option is ignored for symbolic references.)
107107

108-
--rewrite::
108+
`--rewrite`::
109109
If a reflog entry's predecessor is pruned, adjust its "old"
110110
SHA-1 to be equal to the "new" SHA-1 field of the entry that
111111
now precedes it.
112112

113-
--stale-fix::
113+
`--stale-fix`::
114114
Prune any reflog entries that point to "broken commits". A
115115
broken commit is a commit that is not reachable from any of
116116
the reference tips and that refers, directly or indirectly, to
@@ -121,12 +121,12 @@ has the same cost as 'git prune'. It is primarily intended to fix
121121
corruption caused by garbage collecting using older versions of Git,
122122
which didn't protect objects referred to by reflogs.
123123

124-
-n::
125-
--dry-run::
124+
`-n`::
125+
`--dry-run`::
126126
Do not actually prune any entries; just show what would have
127127
been pruned.
128128

129-
--verbose::
129+
`--verbose`::
130130
Print extra information on screen.
131131

132132

@@ -140,10 +140,10 @@ used with `expire`.
140140
Options for `drop`
141141
~~~~~~~~~~~~~~~~~~
142142

143-
--all::
143+
`--all`::
144144
Drop the reflogs of all references from all worktrees.
145145

146-
--single-worktree::
146+
`--single-worktree`::
147147
By default when `--all` is specified, reflogs from all working
148148
trees are dropped. This option limits the processing to reflogs
149149
from the current working tree only.

0 commit comments

Comments
 (0)