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 4/5] documentation: use the word "index" in the git-add manual page
Date: Mon,  6 Aug 2007 00:34:01 -0400	[thread overview]
Message-ID: <6125.06629336185$1186374888@news.gmane.org> (raw)
Message-ID: <5f42ac921fe06bbb80df82d8fa5cb15701ec2f60.1186373089.git.bfields@pig.linuxdev.us.dell.com> (raw)
In-Reply-To: <11863748423686-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>

It was a neat trick to show that you could introduce the git-add manual
page without using the word "index", and it was certainly an improvement
over the previous man page (which started out "A simple wrapper for
git-update-index to add files to the index...").

But it's possible to use the standard terminology without sacrificing
user-friendliness.  So, rewrite to use the word "index" when
appropriate.

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

diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index a0c9f68..37077b5 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -3,7 +3,7 @@ git-add(1)
 
 NAME
 ----
-git-add - Add file contents to the changeset to be committed next
+git-add - Add file contents to the index
 
 SYNOPSIS
 --------
@@ -11,24 +11,27 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-All the changed file contents to be committed together in a single set
-of changes must be "added" with the 'add' command before using the
-'commit' command.  This is not only for adding new files.  Even modified
-files must be added to the set of changes about to be committed.
-
-This command can be performed multiple times before a commit. The added
-content corresponds to the state of specified file(s) at the time the
-'add' command is used. This means the 'commit' command will not consider
-subsequent changes to already added content if it is not added again before
-the commit.
-
-The 'git status' command can be used to obtain a summary of what is included
-for the next commit.
-
-This command can be used to add ignored files with `-f` (force)
-option, but they have to be
-explicitly and exactly specified from the command line.  File globbing
-and recursive behaviour do not add ignored files.
+This command adds the current content of new or modified files to the
+index, thus staging that content for inclusion in the next commit.
+
+The "index" holds a snapshot of the content of the working tree, and it
+is this snapshot that is taken as the contents of the next commit.  Thus
+after making any changes to the working directory, and before running
+the commit command, you must use the 'add' command to add any new or
+modified files to the index.
+
+This command can be performed multiple times before a commit.  It only
+adds the content of the specified file(s) at the time the add command is
+run; if you want subsequent changes included in the next commit, then
+you must run 'git add' again to add the new content to the index.
+
+The 'git status' command can be used to obtain a summary of which
+files have changes that are staged for the next commit.
+
+The 'add' command can be used to add ignored files with `-f` (force)
+option, but they have to be explicitly and exactly specified from the
+command line.  File globbing and recursive behaviour do not add ignored
+files.
 
 Please see gitlink:git-commit[1] for alternative ways to add content to a
 commit.
-- 
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     ` J. Bruce Fields [this message]
     [not found]   ` <d30e77a3798bf9ccaec1efc5f2c7f01d47c35c5c.1186373089.git.bfields@pig.linuxdev.us.dell.com>
2007-08-06  4:34     ` [PATCH 5/5] documentation: use the word "index" in the git-commit man page J. Bruce Fields

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='6125.06629336185$1186374888@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