struct ref_lock: delete the force_write member
[git/git.git] / Documentation / git-reflog.txt
CommitLineData
4aec56d1
JH
1git-reflog(1)
2=============
3
4NAME
5----
6git-reflog - Manage reflog information
7
8
9SYNOPSIS
10--------
7791a1d9 11[verse]
cf39f54e 12'git reflog' <subcommand> <options>
4aec56d1
JH
13
14DESCRIPTION
15-----------
cf39f54e
LT
16The command takes various subcommands, and different options
17depending on the subcommand:
18
19[verse]
04c2407e 20'git reflog expire' [--dry-run] [--stale-fix] [--verbose]
cf39f54e 21 [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...
04c2407e 22'git reflog delete' ref@\{specifier\}...
04c2407e 23'git reflog' ['show'] [log-options] [<ref>]
4aec56d1
JH
24
25Reflog is a mechanism to record when the tip of branches are
26updated. This command is to manage the information recorded in it.
27
28The subcommand "expire" is used to prune older reflog entries.
29Entries older than `expire` time, or entries older than
04c8ce9c 30`expire-unreachable` time and not reachable from the current
4aec56d1 31tip, are removed from the reflog. This is typically not used
5162e697 32directly by the end users -- instead, see linkgit:git-gc[1].
4aec56d1 33
02783075 34The subcommand "show" (which is also the default, in the absence of any
cf39f54e 35subcommands) will take all the normal log options, and show the log of
97e92e2c
MM
36the reference provided in the command-line (or `HEAD`, by default).
37The reflog will cover all recent actions (HEAD reflog records branch switching
db5d6666 38as well). It is an alias for `git log -g --abbrev-commit --pretty=oneline`;
5162e697 39see linkgit:git-log[1].
97e92e2c 40
2de9b711 41The reflog is useful in various Git commands, to specify the old value
6cf378f0
JK
42of a reference. For example, `HEAD@{2}` means "where HEAD used to be
43two moves ago", `master@{one.week.ago}` means "where master used to
9d83e382 44point to one week ago", and so on. See linkgit:gitrevisions[7] for
97e92e2c 45more details.
4aec56d1 46
552cecc2 47To delete single entries from the reflog, use the subcommand "delete"
6cf378f0 48and specify the _exact_ entry (e.g. "`git reflog delete master@{2}`").
552cecc2 49
4aec56d1
JH
50
51OPTIONS
52-------
53
cb877cd7
JN
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.
60+
61This computation involves traversing all the reachable objects, i.e. it
0b444cdb 62has the same cost as 'git prune'. Fortunately, once this is run, we
cb877cd7
JN
63should not have to ever worry about missing objects, because the current
64prune and pack-objects know about reflogs and protect objects referred by
65them.
66
4aec56d1
JH
67--expire=<time>::
68 Entries older than this time are pruned. Without the
69 option it is taken from configuration `gc.reflogExpire`,
61929404
MH
70 which in turn defaults to 90 days. --expire=all prunes
71 entries regardless of their age; --expire=never turns off
72 pruning of reachable entries (but see --expire-unreachable).
4aec56d1
JH
73
74--expire-unreachable=<time>::
04c8ce9c 75 Entries older than this time and not reachable from
4aec56d1
JH
76 the current tip of the branch are pruned. Without the
77 option it is taken from configuration
78 `gc.reflogExpireUnreachable`, which in turn defaults to
61929404
MH
79 30 days. --expire-unreachable=all prunes unreachable
80 entries regardless of their age; --expire-unreachable=never
81 turns off early pruning of unreachable entries (but see
82 --expire).
4aec56d1
JH
83
84--all::
85 Instead of listing <refs> explicitly, prune all refs.
86
cf2756ae
BC
87--updateref::
88 Update the ref with the sha1 of the top reflog entry (i.e.
89 <ref>@\{0\}) after expiring or deleting.
90
91--rewrite::
92 While expiring or deleting, adjust each reflog entry to ensure
93 that the `old` sha1 field points to the `new` sha1 field of the
94 previous entry.
95
a5d41015
MB
96--verbose::
97 Print extra information on screen.
98
4aec56d1
JH
99GIT
100---
9e1f0a85 101Part of the linkgit:git[1] suite