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