kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

documentation: use the word "index" in the git-commit man page 

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
J. Bruce Fields 2007-08-06 00:34:02 -04:00 committed by Junio C Hamano
parent a2c3db8d22
commit a76c2acb28
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/git-commit.txt
View File

@ -15,26 +15,26 @@ SYNOPSIS


DESCRIPTION DESCRIPTION
----------- -----------
Use 'git commit' when you want to record your changes into the repository Use 'git commit' to store the current contents of the index in a new
along with a log message describing what the commit is about. All changes commit along with a log message describing the changes you have made.
to be committed must be explicitly identified using one of the following
methods:


The content to be added can be specified in several ways:
1. by using gitlink:git-add[1] to incrementally "add" changes to the 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"); files must be "added");


2. by using gitlink:git-rm[1] to identify content removal for the next 2. by using gitlink:git-rm[1] to remove files from the working tree
commit, again before using the 'commit' command; and the index, again before using the 'commit' command;


3. by directly listing files containing changes to be committed as arguments 3. by listing files as arguments to the 'commit' command, in which
to the 'commit' command, in which cases only those files alone will be case the commit will ignore changes staged in the index, and instead
considered for the commit; record the current content of the listed files;


4. by using the -a switch with the 'commit' command to automatically "add" 4. by using the -a switch with the 'commit' command to automatically
changes from all known files i.e. files that have already been committed "add" changes from all known files (i.e. all files that are already
before, and to automatically "rm" files that have been listed in the index) and to automatically "rm" files in the index
removed from the working tree, and perform the actual commit. 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 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 by one which files should be part of the commit, before finalizing the