Error in documentation for @{-n} in gitrevisions

3 messages, 3 authors, 2016-06-15 · open the first message on its own page

Error in documentation for @{-n} in gitrevisions

From: Kevin <hidden>
Date: 2016-06-15 22:59:38

While discussing the behavior of "git checkout -", I apparently was
confused because the documentation states:

  The construct @{-<n>} means the <n>th branch checked out before the
current one.

But experimenting with it, it also takes you back to previously
checkout commits.

  git-checkout-at-minus-one :: (master) » git checkout origin/master
  Note: checking out 'origin/master'.
  HEAD is now at f8b2f0c... two

  git-checkout-at-minus-one :: (f8b2f0c) » git checkout -
  Switched to branch 'master'

  git-checkout-at-minus-one :: (master) » git checkout -
                                              Note: checking out
'f8b2f0c1419d1fe798159c2c2578d2dbe1323148'.
  HEAD is now at f8b2f0c... two

Either the documentation is wrong, and should be changed to "<n>th
branch/commit checkout out before the current one", or the behavior of
@{-1} is wrong.

Re: Error in documentation for @{-n} in gitrevisions

From: Ramkumar Ramachandra <hidden>
Date: 2016-06-15 22:59:39

Kevin wrote:
Either the documentation is wrong, and should be changed to "<n>th
branch/commit checkout out before the current one", or the behavior of
@{-1} is wrong.
Yeah, the documentation needs to be updated. Patches welcome.

[PATCH] Documentation: @{-N} can refer to a commit

From: Thomas Rast <hidden>
Date: 2016-06-15 22:59:42

The @{-N} syntax always referred to the N-th last thing checked out,
which can be either a branch or a commit (for detached HEAD cases).
However, the documentation only mentioned branches.

Edit in a "/commit" in the appropriate places.

Reported-by: Kevin <redacted>
Signed-off-by: Thomas Rast <redacted>
---

This is the "minimal" edit.  I'd welcome better wording for the
git-commit manpage, I can't come up with any right now.


 Documentation/git-checkout.txt | 4 ++--
 Documentation/revisions.txt    | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 91294f8..33ad2ad 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -232,8 +232,8 @@ section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
 	commit, your HEAD becomes "detached" and you are no longer on
 	any branch (see below for details).
 +
-As a special case, the `"@{-N}"` syntax for the N-th last branch
-checks out the branch (instead of detaching).  You may also specify
+As a special case, the `"@{-N}"` syntax for the N-th last branch/commit
+checks out branches (instead of detaching).  You may also specify
 `-` which is synonymous with `"@{-1}"`.
 +
 As a further special case, you may use `"A...B"` as a shortcut for the
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 2c06ed3..5a286d0 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -88,7 +88,7 @@ some output processing may assume ref names in UTF-8.
   branch 'blabla' then '@\{1\}' means the same as 'blabla@\{1\}'.
 
 '@\{-<n>\}', e.g. '@\{-1\}'::
-  The construct '@\{-<n>\}' means the <n>th branch checked out
+  The construct '@\{-<n>\}' means the <n>th branch/commit checked out
   before the current one.
 
 '<branchname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
-- 
1.9.rc0.162.g8980120
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help