git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: git@vger.kernel.org
Cc: Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH] Doc fix for git-reflog: mention @{...} syntax, and <ref> in synopsys.
Date: Mon, 19 Nov 2007 19:35:42 +0100	[thread overview]
Message-ID: <1195497342-26334-1-git-send-email-Matthieu.Moy@imag.fr> (raw)
In-Reply-To: <vpqtznirtlk.fsf@bauges.imag.fr>

The HEAD@{...} syntax was documented in git-rev-parse manpage, which
is hard to find by someone looking for the documentation of porcelain.
git-reflog is probably the place where one expects to find this.

While I'm there, "git revlog show whatever" was also undocumented.
---
 Documentation/git-reflog.txt |   11 +++++++++--
 1 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index 5c7316c..aeac6f0 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -19,7 +19,7 @@ depending on the subcommand:
 git reflog expire [--dry-run] [--stale-fix] [--verbose]
 	[--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>...
 
-git reflog [show] [log-options]
+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.
@@ -32,10 +32,17 @@ directly by the end users -- instead, see gitlink:git-gc[1].
 
 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
-`HEAD`, which will cover all recent actions, including branch switches.
+`HEAD`, or of the reference provided in the command-line, which will
+cover all recent actions, including branch switches.
 It is basically an alias for 'git log -g --abbrev-commit
 --pretty=oneline', see gitlink: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 gitlink:git-rev-parse[1] for
+more details.
+
 
 OPTIONS
 -------
-- 
1.5.3.5.724.g49d9d

  reply	other threads:[~2007-11-19 18:36 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-11-19 13:05 Git in a Nutshell guide Jonas Juselius
2007-11-19 13:29 ` Jakub Narebski
2007-11-19 14:33   ` Jonas Juselius
2007-11-22  8:22   ` David Kågedal
2007-11-23  9:28     ` Jakub Narebski
2007-11-19 15:02 ` Brian Downing
2007-11-19 15:03   ` Brian Downing
2007-11-19 15:48   ` Nicolas Pitre
2007-11-19 16:05 ` Jakub Narebski
2007-11-19 16:14   ` Jonas Juselius
2007-11-19 16:49     ` Benoit Sigoure
2007-11-19 22:01       ` Daniel Barkalow
2007-11-20 11:34       ` Jonas Juselius
2007-11-20 23:57       ` Jakub Narebski
2007-11-21 19:45         ` Jan Hudec
2007-11-21 21:32           ` Jakub Narebski
2007-11-22 16:37             ` jhud7196
2007-11-22 13:15   ` Jonas Juselius
2007-11-22 14:19     ` Jonathan del Strother
2007-11-22 14:24     ` Johannes Schindelin
2007-11-22 16:57     ` jhud7196
2007-11-19 16:45 ` Lars Hjemli
2007-11-19 16:56   ` Jonas Juselius
2007-11-19 16:57   ` Benoit Sigoure
2007-11-19 17:04     ` Lars Hjemli
2007-11-19 18:10       ` Benoit Sigoure
2007-11-19 18:13         ` J. Bruce Fields
2007-11-19 18:13         ` Matthieu Moy
2007-11-19 18:35           ` Matthieu Moy [this message]
2007-11-19 20:13             ` [PATCH] Doc fix for git-reflog: mention @{...} syntax, and <ref> in synopsys Junio C Hamano
2007-11-19 20:28               ` Matthieu Moy
2007-11-19 20:31                 ` Matthieu Moy
2007-11-19 21:15           ` Git in a Nutshell guide Benoit Sigoure
2007-11-19 21:33             ` Matthieu Moy
2007-11-19 21:51               ` Benoit Sigoure
2007-11-19 22:23                 ` J. Bruce Fields
2007-11-19 22:29                 ` Junio C Hamano
2007-11-19 22:59                   ` Matthieu Moy
2007-11-19 23:07                     ` Junio C Hamano
2007-11-19 17:05     ` Matthieu Moy

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=1195497342-26334-1-git-send-email-Matthieu.Moy@imag.fr \
    --to=matthieu.moy@imag.fr \
    --cc=git@vger.kernel.org \
    /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).