Merge branch 'maint'
[git/mjg.git] / Documentation / git-reflog.txt
blobe50bd9b68d80e9be997de80252dec5afbb7452b4
1 git-reflog(1)
2 =============
4 NAME
5 ----
6 git-reflog - Manage reflog information
9 SYNOPSIS
10 --------
11 'git reflog' <subcommand> <options>
13 DESCRIPTION
14 -----------
15 The command takes various subcommands, and different options
16 depending on the subcommand:
18 [verse]
19 'git reflog expire' [--dry-run] [--stale-fix] [--verbose]
20         [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...
21 'git reflog delete' ref@\{specifier\}...
22 'git reflog' ['show'] [log-options] [<ref>]
24 Reflog is a mechanism to record when the tip of branches are
25 updated.  This command is to manage the information recorded in it.
27 The subcommand "expire" is used to prune older reflog entries.
28 Entries older than `expire` time, or entries older than
29 `expire-unreachable` time and not reachable from the current
30 tip, are removed from the reflog.  This is typically not used
31 directly by the end users -- instead, see linkgit:git-gc[1].
33 The subcommand "show" (which is also the default, in the absence of any
34 subcommands) will take all the normal log options, and show the log of
35 the reference provided in the command-line (or `HEAD`, by default).
36 The reflog will cover all recent actions (HEAD reflog records branch switching
37 as well).  It is an alias for `git log -g --abbrev-commit --pretty=oneline`;
38 see linkgit:git-log[1].
40 The reflog is useful in various git commands, to specify the old value
41 of a reference. For example, `HEAD@\{2\}` means "where HEAD used to be
42 two moves ago", `master@\{one.week.ago\}` means "where master used to
43 point to one week ago", and so on. See linkgit:gitrevisions[7] for
44 more details.
46 To delete single entries from the reflog, use the subcommand "delete"
47 and specify the _exact_ entry (e.g. "`git reflog delete master@\{2\}`").
50 OPTIONS
51 -------
53 --stale-fix::
54         This revamps the logic -- the definition of "broken commit"
55         becomes: a commit that is not reachable from any of the refs and
56         there is a missing object among the commit, tree, or blob
57         objects reachable from it that is not reachable from any of the
58         refs.
60 This computation involves traversing all the reachable objects, i.e. it
61 has the same cost as 'git prune'.  Fortunately, once this is run, we
62 should not have to ever worry about missing objects, because the current
63 prune and pack-objects know about reflogs and protect objects referred by
64 them.
66 --expire=<time>::
67         Entries older than this time are pruned.  Without the
68         option it is taken from configuration `gc.reflogExpire`,
69         which in turn defaults to 90 days.
71 --expire-unreachable=<time>::
72         Entries older than this time and not reachable from
73         the current tip of the branch are pruned.  Without the
74         option it is taken from configuration
75         `gc.reflogExpireUnreachable`, which in turn defaults to
76         30 days.
78 --all::
79         Instead of listing <refs> explicitly, prune all refs.
81 --updateref::
82         Update the ref with the sha1 of the top reflog entry (i.e.
83         <ref>@\{0\}) after expiring or deleting.
85 --rewrite::
86         While expiring or deleting, adjust each reflog entry to ensure
87         that the `old` sha1 field points to the `new` sha1 field of the
88         previous entry.
90 --verbose::
91         Print extra information on screen.
93 Author
94 ------
95 Written by Junio C Hamano <gitster@pobox.com>
97 Documentation
98 --------------
99 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
103 Part of the linkgit:git[1] suite