reflog doc: list real subcommands up-front
Change the "git reflog" documentation to exhaustively list the subcommands it accepts in the SYNOPSIS, as opposed to leaving that for a "[verse]" in the DESCRIPTION section. This documentation style was added in cf39f54efc6 (git reflog show, 2007-02-08), but isn't how other commands which take subcommands are documented. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Oct 13, 2022 at 17:39 UTC
4618d2ca827505a7bb60c30c8ac3f1446619ec1d
1 file changed
+6
-9
Documentation/git-reflog.txt
+6
-9
@@ -8,14 +8,6 @@ git-reflog - Manage reflog information
8
9
SYNOPSIS
10
--------
11
-[verse]
12
-'git reflog' <subcommand> <options>
13
-
14
-DESCRIPTION
15
------------
16
-The command takes various subcommands, and different options
17
-depending on the subcommand:
18
-
11
[verse]
12
'git reflog' [show] [<log-options>] [<ref>]
13
'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>]
@@ -25,6 +17,10 @@ depending on the subcommand:
17
[--dry-run | -n] [--verbose] <ref>@{<specifier>}...
18
'git reflog exists' <ref>
19
20
+DESCRIPTION
21
+-----------
22
+This command manages the information recorded in the reflogs.
23
+
24
Reference logs, or "reflogs", record when the tips of branches and
25
other references were updated in the local repository. Reflogs are
26
useful in various Git commands, to specify the old value of a
@@ -33,7 +29,8 @@ moves ago", `master@{one.week.ago}` means "where master used to point
29
to one week ago in this local repository", and so on. See
30
linkgit:gitrevisions[7] for more details.
31
36
-This command manages the information recorded in the reflogs.
32
+The command takes various subcommands, and different options
33
+depending on the subcommand:
34
35
The "show" subcommand (which is also the default, in the absence of
36
any subcommands) shows the log of the reference provided in the