Merge branch 'master' of git://git.kernel.org/pub/scm/git/git
[git/jnareb-git.git] / Documentation / git-reflog.txt
blobed39de18e29802caebcba7c8882a45613da2c303
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]
20         [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...
22 git reflog [show] [log-options]
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 are not reachable from the current
30 tip, are removed from the reflog.  Entries which refer to
31 commits that are no longer in the repository are pruned
32 regardless of their age.  This command is typically not used
33 directly by the end users -- instead, see gitlink:git-gc[1].
35 The subcommand "show" (which is also the default, in the absence of any
36 subcommands) will take all the normal log options, and show the log of
37 `HEAD`, which will cover all recent actions, including branch switches.
38 It is basically an alias for 'git log -g --abbrev-commit
39 --pretty=oneline', see gitlink:git-log[1].
41 OPTIONS
42 -------
44 --stale-fix::
45         This revamps the logic -- the definition of "broken commit"
46         becomes: a commit that is not reachable from any of the refs and
47         there is a missing object among the commit, tree, or blob
48         objects reachable from it that is not reachable from any of the
49         refs.
51 This computation involves traversing all the reachable objects, i.e. it
52 has the same cost as 'git prune'.  Fortunately, once this is run, we
53 should not have to ever worry about missing objects, because the current
54 prune and pack-objects know about reflogs and protect objects referred by
55 them.
57 --expire=<time>::
58         Entries older than this time are pruned.  Without the
59         option it is taken from configuration `gc.reflogExpire`,
60         which in turn defaults to 90 days.
62 --expire-unreachable=<time>::
63         Entries older than this time and are not reachable from
64         the current tip of the branch are pruned.  Without the
65         option it is taken from configuration
66         `gc.reflogExpireUnreachable`, which in turn defaults to
67         30 days.
69 --all::
70         Instead of listing <refs> explicitly, prune all refs.
72 Author
73 ------
74 Written by Junio C Hamano <junkio@cox.net>
76 Documentation
77 --------------
78 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
80 GIT
81 ---
82 Part of the gitlink:git[7] suite