undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

reflog doc: list real subcommands up-front

Browse Source 
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 cf39f54efc (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>
This commit is contained in:
Ævar Arnfjörð Bjarmason 2022-10-13 17:39:24 +02:00 committed by Junio C Hamano
parent 423be1f83c
commit 4618d2ca82
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/git-reflog.txt
View File

@ -8,14 +8,6 @@ git-reflog - Manage reflog information
SYNOPSIS SYNOPSIS
-------- --------
[verse]
'git reflog' <subcommand> <options>
DESCRIPTION
-----------
The command takes various subcommands, and different options
depending on the subcommand:
[verse] [verse]
'git reflog' [show] [<log-options>] [<ref>] 'git reflog' [show] [<log-options>] [<ref>]
'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>] 'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>]
@ -25,6 +17,10 @@ depending on the subcommand:
[--dry-run | -n] [--verbose] <ref>@{<specifier>}... [--dry-run | -n] [--verbose] <ref>@{<specifier>}...
'git reflog exists' <ref> 'git reflog exists' <ref>
DESCRIPTION
-----------
This command manages the information recorded in the reflogs.
Reference logs, or "reflogs", record when the tips of branches and Reference logs, or "reflogs", record when the tips of branches and
other references were updated in the local repository. Reflogs are other references were updated in the local repository. Reflogs are
useful in various Git commands, to specify the old value of a 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
to one week ago in this local repository", and so on. See to one week ago in this local repository", and so on. See
linkgit:gitrevisions[7] for more details. linkgit:gitrevisions[7] for more details.
This command manages the information recorded in the reflogs. The command takes various subcommands, and different options
depending on the subcommand:
The "show" subcommand (which is also the default, in the absence of The "show" subcommand (which is also the default, in the absence of
any subcommands) shows the log of the reference provided in the any subcommands) shows the log of the reference provided in the