Git development
 help / color / mirror / Atom feed
From: "J. Bruce Fields" <bfields@citi.umich.edu>
To: gitster@pobox.com
Cc: git@vger.kernel.org,
	"J. Bruce Fields" <bfields@pig.linuxdev.us.dell.com>,
	"J. Bruce Fields" <bfields@citi.umich.edu>
Subject: [PATCH 5/5] documentation: use the word "index" in the git-commit man page
Date: Mon,  6 Aug 2007 00:34:02 -0400	[thread overview]
Message-ID: <6996.37848088077$1186374891@news.gmane.org> (raw)
Message-ID: <d30e77a3798bf9ccaec1efc5f2c7f01d47c35c5c.1186373089.git.bfields@pig.linuxdev.us.dell.com> (raw)
In-Reply-To: <1186374842283-git-send-email->
In-Reply-To: <0eb4f7cdf85273c88feb95c677a808cee9cfd859.1186373089.git.bfields@pig.linuxdev.us.dell.com>

From: J. Bruce Fields <bfields@pig.linuxdev.us.dell.com>

As with git-add, I think previous updates to the git-commit man page did
indeed help make it more user-friendly.  But I think the banishment of
the word "index" from the description goes too far; reinstate its use,
to simplify some of the language slightly and smooth the transition to
other documentation.

Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu>
---
 Documentation/git-commit.txt |   28 ++++++++++++++--------------
 1 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 53a7bb0..f07a330 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -15,26 +15,26 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Use 'git commit' when you want to record your changes into the repository
-along with a log message describing what the commit is about. All changes
-to be committed must be explicitly identified using one of the following
-methods:
+Use 'git commit' to store the current contents of the index in a new
+commit along with a log message describing the changes you have made.
 
+The content to be added can be specified in several ways:
 1. by using gitlink:git-add[1] to incrementally "add" changes to the
-   next commit before using the 'commit' command (Note: even modified
+   index before using the 'commit' command (Note: even modified
    files must be "added");
 
-2. by using gitlink:git-rm[1] to identify content removal for the next
-   commit, again before using the 'commit' command;
+2. by using gitlink:git-rm[1] to remove files from the working tree
+   and the index, again before using the 'commit' command;
 
-3. by directly listing files containing changes to be committed as arguments
-   to the 'commit' command, in which cases only those files alone will be
-   considered for the commit;
+3. by listing files as arguments to the 'commit' command, in which
+   case the commit will ignore changes staged in the index, and instead
+   record the current content of the listed files;
 
-4. by using the -a switch with the 'commit' command to automatically "add"
-   changes from all known files i.e. files that have already been committed
-   before, and to automatically "rm" files that have been
-   removed from the working tree, and perform the actual commit.
+4. by using the -a switch with the 'commit' command to automatically
+   "add" changes from all known files (i.e. all files that are already
+   listed in the index) and to automatically "rm" files in the index
+   that have been removed from the working tree, and then perform the
+   actual commit;
 
 5. by using the --interactive switch with the 'commit' command to decide one
    by one which files should be part of the commit, before finalizing the
-- 
1.5.3.GIT

      parent reply	other threads:[~2007-08-06  4:34 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <11863748422001-git-send-email->
     [not found] ` <1186374842108-git-send-email->
     [not found]   ` <11863748422754-git-send-email->
     [not found]     ` <11863748423686-git-send-email->
     [not found] ` <0eb4f7cdf85273c88feb95c677a808cee9cfd859.1186373089.git.bfields@pig.linuxdev.us.dell.com>
2007-08-06  4:33   ` [PATCH 1/5] user-manual: update for new default --track behavior J. Bruce Fields
     [not found]   ` <7a7cc594ca294a58b6d7ae5aa50a65378538e875.1186373089.git.bfields@pig.linuxdev.us.dell.com>
2007-08-06  4:33     ` [PATCH 2/5] user-manual: mention git stash J. Bruce Fields
     [not found]   ` <407c0c87e15b3cf60347f4fc0bcdb4d239de4163.1186373089.git.bfields@pig.linuxdev.us.dell.com>
2007-08-06  4:34     ` [PATCH 3/5] user-manual: mention git-gui J. Bruce Fields
     [not found]   ` <5f42ac921fe06bbb80df82d8fa5cb15701ec2f60.1186373089.git.bfields@pig.linuxdev.us.dell.com>
2007-08-06  4:34     ` [PATCH 4/5] documentation: use the word "index" in the git-add manual page J. Bruce Fields
     [not found]   ` <d30e77a3798bf9ccaec1efc5f2c7f01d47c35c5c.1186373089.git.bfields@pig.linuxdev.us.dell.com>
2007-08-06  4:34     ` J. Bruce Fields [this message]

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='6996.37848088077$1186374891@news.gmane.org' \
    --to=bfields@citi.umich.edu \
    --cc=bfields@pig.linuxdev.us.dell.com \
    --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