From: Michael J Gruber <git@drmicha.warpmail.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
Christian Couder <chriscool@tuxfamily.org>
Subject: [PATCH 6/6] git-reset.txt: make modes description more consistent
Date: Mon, 13 Sep 2010 10:06:36 +0200 [thread overview]
Message-ID: <d4a048c1cfd39a2d7ab8a86554bb48937629620c.1284365021.git.git@drmicha.warpmail.net> (raw)
In-Reply-To: <cover.1284365021.git.git@drmicha.warpmail.net>
Currently, the structure of the individual mode entries is different
which makes it difficult to grasp the differences between the modes.
Also, the same items are named differently (e.g. <commit>, "the named
commit", "the given commit", "the commit being switched to").
Structure and word all mode entries consistently.
Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
Documentation/git-reset.txt | 43 ++++++++++++++++++++++++++-----------------
1 files changed, 26 insertions(+), 17 deletions(-)
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 40e2fd8..6b60b59 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -15,13 +15,13 @@ SYNOPSIS
DESCRIPTION
-----------
In the first and second form, copy entries from <commit> to the index.
-In the third form, set the current branch head to <commit>, optionally
+In the third form, set the current branch head (HEAD) to <commit>, optionally
modifying index and working tree to match. The <commit> defaults to HEAD
in all forms.
'git reset' [-q] [<commit>] [--] <paths>...::
This form resets the index entries for all <paths> to their
- state at the <commit>. (It does not affect the working tree, nor
+ state at <commit>. (It does not affect the working tree, nor
the current branch.)
+
This means that `git reset <paths>` is the opposite of `git add
@@ -39,9 +39,10 @@ This means that `git reset -p` is the opposite of `git add -p` (see
linkgit:git-add[1]).
'git reset' [--<mode>] [<commit>]::
- This form sets the current branch head to <commit> and then
- updates index and working tree according to <mode>, which must
- be one of the following:
+ This form sets the current branch head to <commit> and
+ possibly updates the index (resetting it to the tree of <commit>) and
+ the working tree depending on <mode>, which
+ must be one of the following:
+
--
--soft::
@@ -57,22 +58,30 @@ linkgit:git-add[1]).
been updated. This is the default action.
--hard::
- Matches the working tree and index to that of the tree being
- switched to. Any changes to tracked files in the working tree
- since <commit> are lost.
+ Resets the index and working tree. Any changes to tracked files in the
+ working tree since <commit> are lost.
--merge::
- Resets the index to match the tree recorded by the named commit,
- and updates the files that are different between the named commit
- and the current commit in the working tree.
+ Resets the index and updates the files in the working tree that are
+ different between <commit> and HEAD, but keeps those which are
+ different between the index and working tree (i.e. which have unstaged
+ changes).
+ If a file that is different between <commit> and the index has unstaged
+ changes, reset is aborted.
++
+In other words, --merge does something like a 'git read-tree -u -m <commit>',
+but carries forward unmerged index entries.
--keep::
- Reset the index to the given commit, keeping local changes in
- the working tree since the current commit, while updating
- working tree files without local changes to what appears in
- the given commit. If a file that is different between the
- current commit and the given commit has local changes, reset
- is aborted.
+ Resets the index, updates files in the working tree that are
+ different between <commit> and HEAD, but keeps those
+ which are different between HEAD and the working tree (i.e.
+ which have local changes).
+ If a file that is different between <commit> and HEAD has local changes,
+ reset is aborted.
++
+In other words, --keep does a 2-way merge between <commit> and HEAD followed by
+'git reset --mixed <commit>'.
--
If you want to undo a commit other than the latest on a branch,
--
1.7.3.rc1.215.g6997c
next prev parent reply other threads:[~2010-09-13 8:16 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-09-13 8:06 [PATCH 0/6] git-reset.txt improvements Michael J Gruber
2010-09-13 8:06 ` [PATCH 1/6] git-reset.txt: clarify branch vs. branch head Michael J Gruber
2010-09-14 0:35 ` Junio C Hamano
2010-09-13 8:06 ` [PATCH 2/6] git-reset.txt: reset does not change files in target Michael J Gruber
2010-09-14 0:12 ` Junio C Hamano
2010-09-13 8:06 ` [PATCH 3/6] git-reset.txt: reset --soft is not a no-op Michael J Gruber
2010-09-13 22:13 ` Jay Soffian
2010-09-13 23:19 ` Junio C Hamano
2010-09-13 8:06 ` [PATCH 4/6] git-reset.txt: use "working tree" consistently Michael J Gruber
2010-09-13 8:06 ` [PATCH 5/6] git-reset.txt: point to git-checkout Michael J Gruber
2010-09-14 0:19 ` Junio C Hamano
2010-09-13 8:06 ` Michael J Gruber [this message]
2010-09-14 0:35 ` [PATCH 6/6] git-reset.txt: make modes description more consistent Junio C Hamano
2010-09-15 20:47 ` Michael J Gruber
2010-09-13 22:15 ` [PATCH 0/6] git-reset.txt improvements Jay Soffian
2010-09-15 20:47 ` [PATCHv2 " Michael J Gruber
2010-09-15 20:47 ` [PATCHv2 1/6] git-reset.txt: clarify branch vs. branch head Michael J Gruber
2010-09-15 20:47 ` [PATCHv2 2/6] git-reset.txt: reset does not change files in target Michael J Gruber
2010-09-15 20:47 ` [PATCHv2 3/6] git-reset.txt: reset --soft is not a no-op Michael J Gruber
2010-09-15 20:47 ` [PATCHv2 4/6] git-reset.txt: use "working tree" consistently Michael J Gruber
2010-09-15 20:47 ` [PATCHv2 5/6] git-reset.txt: point to git-checkout Michael J Gruber
2010-09-15 20:47 ` [PATCHv2 6/6] git-reset.txt: make modes description more consistent Michael J Gruber
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=d4a048c1cfd39a2d7ab8a86554bb48937629620c.1284365021.git.git@drmicha.warpmail.net \
--to=git@drmicha.warpmail.net \
--cc=chriscool@tuxfamily.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).