@matheusbsbs / matheus-bagliano / commits / a76c2acb28
Fork 0

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>

J. Bruce Fields committed Aug 6, 2007 at 00:34 UTC a76c2acb28146f5630592f2ba738c0ebf0f3c1c4
1 file changed +14 -14
Documentation/git-commit.txt
+14 -14
@@ -15,26 +15,26 @@ SYNOPSIS
15
16 DESCRIPTION
17 -----------
18 -Use 'git commit' when you want to record your changes into the repository
19 -along with a log message describing what the commit is about. All changes
20 -to be committed must be explicitly identified using one of the following
21 -methods:
18 +Use 'git commit' to store the current contents of the index in a new
19 +commit along with a log message describing the changes you have made.
20
21 +The content to be added can be specified in several ways:
22 1. by using gitlink:git-add[1] to incrementally "add" changes to the
24 - next commit before using the 'commit' command (Note: even modified
23 + index before using the 'commit' command (Note: even modified
24 files must be "added");
25
27 -2. by using gitlink:git-rm[1] to identify content removal for the next
28 - commit, again before using the 'commit' command;
26 +2. by using gitlink:git-rm[1] to remove files from the working tree
27 + and the index, again before using the 'commit' command;
28
30 -3. by directly listing files containing changes to be committed as arguments
31 - to the 'commit' command, in which cases only those files alone will be
32 - considered for the commit;
29 +3. by listing files as arguments to the 'commit' command, in which
30 + case the commit will ignore changes staged in the index, and instead
31 + record the current content of the listed files;
32
34 -4. by using the -a switch with the 'commit' command to automatically "add"
35 - changes from all known files i.e. files that have already been committed
36 - before, and to automatically "rm" files that have been
37 - removed from the working tree, and perform the actual commit.
33 +4. by using the -a switch with the 'commit' command to automatically
34 + "add" changes from all known files (i.e. all files that are already
35 + listed in the index) and to automatically "rm" files in the index
36 + that have been removed from the working tree, and then perform the
37 + actual commit;
38
39 5. by using the --interactive switch with the 'commit' command to decide one
40 by one which files should be part of the commit, before finalizing the