Documentation: Correct various misspellings and typos.
[git/builtin-gsoc.git] / Documentation / git-reflog.txt
blob5180f6810d8e789f7d677aab0ad37bae93e72cca
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.  This is typically not used
31 directly by the end users -- instead, see gitlink: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 `HEAD`, which will cover all recent actions, including branch switches.
36 It is basically an alias for 'git log -g --abbrev-commit
37 --pretty=oneline', see gitlink:git-log[1].
40 OPTIONS
41 -------
43 --stale-fix::
44         This revamps the logic -- the definition of "broken commit"
45         becomes: a commit that is not reachable from any of the refs and
46         there is a missing object among the commit, tree, or blob
47         objects reachable from it that is not reachable from any of the
48         refs.
50 This computation involves traversing all the reachable objects, i.e. it
51 has the same cost as 'git prune'.  Fortunately, once this is run, we
52 should not have to ever worry about missing objects, because the current
53 prune and pack-objects know about reflogs and protect objects referred by
54 them.
56 --expire=<time>::
57         Entries older than this time are pruned.  Without the
58         option it is taken from configuration `gc.reflogExpire`,
59         which in turn defaults to 90 days.
61 --expire-unreachable=<time>::
62         Entries older than this time and are not reachable from
63         the current tip of the branch are pruned.  Without the
64         option it is taken from configuration
65         `gc.reflogExpireUnreachable`, which in turn defaults to
66         30 days.
68 --all::
69         Instead of listing <refs> explicitly, prune all refs.
71 Author
72 ------
73 Written by Junio C Hamano <junkio@cox.net>
75 Documentation
76 --------------
77 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
79 GIT
80 ---
81 Part of the gitlink:git[7] suite