Skip to content

Commit 4618d2c

Browse files
avargitster
authored andcommitted
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 cf39f54 (git reflog show, 2007-02-08), but isn't how other commands which take subcommands are documented. Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 423be1f commit 4618d2c

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

Documentation/git-reflog.txt

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

99
SYNOPSIS
1010
--------
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-
1911
[verse]
2012
'git reflog' [show] [<log-options>] [<ref>]
2113
'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>]
@@ -25,6 +17,10 @@ depending on the subcommand:
2517
[--dry-run | -n] [--verbose] <ref>@{<specifier>}...
2618
'git reflog exists' <ref>
2719

20+
DESCRIPTION
21+
-----------
22+
This command manages the information recorded in the reflogs.
23+
2824
Reference logs, or "reflogs", record when the tips of branches and
2925
other references were updated in the local repository. Reflogs are
3026
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
3329
to one week ago in this local repository", and so on. See
3430
linkgit:gitrevisions[7] for more details.
3531

36-
This command manages the information recorded in the reflogs.
32+
The command takes various subcommands, and different options
33+
depending on the subcommand:
3734

3835
The "show" subcommand (which is also the default, in the absence of
3936
any subcommands) shows the log of the reference provided in the

0 commit comments

Comments
 (0)