From: Michael Haggerty <mhagger@alum.mit.edu>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Stefan Beller" <sbeller@google.com>,
"Ronnie Sahlberg" <ronniesahlberg@gmail.com>,
"Jonathan Nieder" <jrnieder@gmail.com>,
"Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
git@vger.kernel.org, "Michael Haggerty" <mhagger@alum.mit.edu>
Subject: [PATCH 5/8] reflog: rearrange the manpage
Date: Mon, 9 Feb 2015 10:12:41 +0100 [thread overview]
Message-ID: <1423473164-6011-6-git-send-email-mhagger@alum.mit.edu> (raw)
In-Reply-To: <1423473164-6011-1-git-send-email-mhagger@alum.mit.edu>
Rearrange the "git reflog" manpage to list more common operations
earlier.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
Documentation/git-reflog.txt | 56 ++++++++++++++++++++++----------------------
1 file changed, 28 insertions(+), 28 deletions(-)
diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index b410ee6..f15a48e 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -17,21 +17,21 @@ The command takes various subcommands, and different options
depending on the subcommand:
[verse]
+'git reflog' ['show'] [log-options] [<ref>]
'git reflog expire' [--dry-run] [--verbose]
[--rewrite] [--updateref] [--stale-fix]
[--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...
'git reflog delete' [--dry-run] [--verbose]
[--rewrite] [--updateref] ref@\{specifier\}...
-'git reflog' ['show'] [log-options] [<ref>]
-Reflog is a mechanism to record when the tip of branches are
-updated. This command is to manage the information recorded in it.
+Reflog is a mechanism to record when the tips of branches are updated.
+The reflog is useful in various Git commands, to specify the old value
+of a reference. For example, `HEAD@{2}` means "where HEAD used to be
+two moves ago", `master@{one.week.ago}` means "where master used to
+point to one week ago", and so on. See linkgit:gitrevisions[7] for
+more details.
-The subcommand "expire" is used to prune older reflog entries.
-Entries older than `expire` time, or entries older than
-`expire-unreachable` time and not reachable from the current
-tip, are removed from the reflog. This is typically not used
-directly by the end users -- instead, see linkgit:git-gc[1].
+This command manages the information recorded in the reflog.
The subcommand "show" (which is also the default, in the absence of any
subcommands) will take all the normal log options, and show the log of
@@ -40,11 +40,11 @@ The reflog will cover all recent actions (HEAD reflog records branch switching
as well). It is an alias for `git log -g --abbrev-commit --pretty=oneline`;
see linkgit:git-log[1].
-The reflog is useful in various Git commands, to specify the old value
-of a reference. For example, `HEAD@{2}` means "where HEAD used to be
-two moves ago", `master@{one.week.ago}` means "where master used to
-point to one week ago", and so on. See linkgit:gitrevisions[7] for
-more details.
+The subcommand "expire" is used to prune older reflog entries.
+Entries older than `expire` time, or entries older than
+`expire-unreachable` time and not reachable from the current
+tip, are removed from the reflog. This is typically not used
+directly by the end users -- instead, see linkgit:git-gc[1].
To delete single entries from the reflog, use the subcommand "delete"
and specify the _exact_ entry (e.g. "`git reflog delete master@{2}`").
@@ -53,19 +53,6 @@ and specify the _exact_ entry (e.g. "`git reflog delete master@{2}`").
OPTIONS
-------
---stale-fix::
- This revamps the logic -- the definition of "broken commit"
- becomes: a commit that is not reachable from any of the refs and
- there is a missing object among the commit, tree, or blob
- objects reachable from it that is not reachable from any of the
- refs.
-+
-This computation involves traversing all the reachable objects, i.e. it
-has the same cost as 'git prune'. Fortunately, once this is run, we
-should not have to ever worry about missing objects, because the current
-prune and pack-objects know about reflogs and protect objects referred by
-them.
-
--expire=<time>::
Entries older than this time are pruned. Without the
option it is taken from configuration `gc.reflogExpire`,
@@ -83,8 +70,18 @@ them.
turns off early pruning of unreachable entries (but see
--expire).
---all::
- Instead of listing <refs> explicitly, prune all refs.
+--stale-fix::
+ This revamps the logic -- the definition of "broken commit"
+ becomes: a commit that is not reachable from any of the refs and
+ there is a missing object among the commit, tree, or blob
+ objects reachable from it that is not reachable from any of the
+ refs.
++
+This computation involves traversing all the reachable objects, i.e. it
+has the same cost as 'git prune'. Fortunately, once this is run, we
+should not have to ever worry about missing objects, because the current
+prune and pack-objects know about reflogs and protect objects referred by
+them.
--updateref::
Update the ref with the sha1 of the top reflog entry (i.e.
@@ -98,6 +95,9 @@ them.
--verbose::
Print extra information on screen.
+--all::
+ Instead of listing <refs> explicitly, prune all refs.
+
GIT
---
Part of the linkgit:git[1] suite
--
2.1.4
next prev parent reply other threads:[~2015-02-09 9:13 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-02-09 9:12 [PATCH 0/8] Fix some problems with reflog expiration Michael Haggerty
2015-02-09 9:12 ` [PATCH 1/8] write_ref_sha1(): remove check for lock == NULL Michael Haggerty
2015-02-10 22:52 ` Stefan Beller
2015-02-11 0:06 ` Jeff King
2015-02-09 9:12 ` [PATCH 2/8] write_ref_sha1(): Move write elision test to callers Michael Haggerty
2015-02-12 19:58 ` Junio C Hamano
2015-02-09 9:12 ` [PATCH 3/8] lock_ref_sha1_basic(): do not set force_write for missing references Michael Haggerty
2015-02-10 23:24 ` Stefan Beller
2015-02-11 0:05 ` Jeff King
2015-02-11 0:07 ` Stefan Beller
2015-02-12 12:09 ` Michael Haggerty
2015-02-09 9:12 ` [PATCH 4/8] reflog: fix documentation Michael Haggerty
2015-02-10 23:25 ` Stefan Beller
2015-02-09 9:12 ` Michael Haggerty [this message]
2015-02-10 23:42 ` [PATCH 5/8] reflog: rearrange the manpage Stefan Beller
2015-02-12 15:17 ` Michael Haggerty
2015-02-12 20:09 ` Junio C Hamano
2015-02-09 9:12 ` [PATCH 6/8] reflog_expire(): ignore --updateref for symbolic references Michael Haggerty
2015-02-11 0:44 ` Stefan Beller
2015-02-12 16:08 ` Michael Haggerty
2015-02-12 17:04 ` Stefan Beller
2015-02-12 20:16 ` Junio C Hamano
2015-02-12 21:54 ` Jeff King
2015-02-13 14:34 ` Michael Haggerty
2015-02-09 9:12 ` [PATCH 7/8] reflog_expire(): never update a reference to null_sha1 Michael Haggerty
2015-02-09 20:55 ` Eric Sunshine
2015-02-12 11:51 ` Michael Haggerty
2015-02-09 9:12 ` [PATCH 8/8] reflog_expire(): lock symbolic refs themselves, not their referent Michael Haggerty
2015-02-11 0:49 ` Stefan Beller
2015-02-11 22:49 ` Junio C Hamano
2015-02-11 23:25 ` Stefan Beller
2015-02-12 16:52 ` Michael Haggerty
2015-02-12 18:04 ` Stefan Beller
2015-02-13 16:26 ` Michael Haggerty
2015-02-13 17:16 ` Stefan Beller
2015-02-13 18:05 ` Junio C Hamano
2015-02-13 18:21 ` Stefan Beller
2015-02-13 18:26 ` Junio C Hamano
2015-02-13 18:32 ` Stefan Beller
2015-02-13 19:12 ` Junio C Hamano
2015-02-13 20:11 ` Michael Haggerty
2015-02-13 21:53 ` Junio C Hamano
2015-02-14 5:58 ` Michael Haggerty
2015-02-09 18:57 ` [PATCH 0/8] Fix some problems with reflog expiration Stefan Beller
2015-02-10 23:12 ` [PATCH] refs.c: get rid of force_write flag Stefan Beller
2015-02-12 15:35 ` Michael Haggerty
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1423473164-6011-6-git-send-email-mhagger@alum.mit.edu \
--to=mhagger@alum.mit.edu \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jrnieder@gmail.com \
--cc=pclouds@gmail.com \
--cc=ronniesahlberg@gmail.com \
--cc=sbeller@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).