Documentation: point to related commands from gitignore
A frequently asked question on #git is how to stop tracking a file that is mistakenly tracked by git. A frequently attempted strategy is to add such files to .gitignore. Thus one might imagine that the gitignore documentation could be a good entry point for 'git rm' documentation. Add some cross-references in this vein. While at it, move a reference to update-index --assume-unchanged from the DESCRIPTION to lower down on the page. This way, the methodical reader can benefit from first learning what excludes files do, then how they relate to other git facilities. Based-on-patch-by: Sitaram Chamarty <sitaram@atc.tcs.com> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
Nov 10, 2010 at 13:00 UTC
6f02a5a33a3983597992e94c7b826021acc8a9d9
1 file changed
+19
-5
Documentation/gitignore.txt
+19
-5
@@ -14,11 +14,8 @@ DESCRIPTION
14
15
A `gitignore` file specifies intentionally untracked files that
16
git should ignore.
17
-Note that all the `gitignore` files really concern only files
18
-that are not already tracked by git;
19
-in order to ignore uncommitted changes in already tracked files,
20
-please refer to the 'git update-index --assume-unchanged'
21
-documentation.
17
+Files already tracked by git are not affected; see the NOTES
18
+below for details.
19
20
Each line in a `gitignore` file specifies a pattern.
21
When deciding whether to ignore a path, git normally checks
@@ -99,6 +96,18 @@ PATTERN FORMAT
96
For example, "/{asterisk}.c" matches "cat-file.c" but not
97
"mozilla-sha1/sha1.c".
98
99
+NOTES
100
+-----
101
+
102
+The purpose of gitignore files is to ensure that certain files
103
+not tracked by git remain untracked.
104
+
105
+To ignore uncommitted changes in a file that is already tracked,
106
+use 'git update-index {litdd}assume-unchanged'.
107
+
108
+To stop tracking a file that is currently tracked, use
109
+'git rm --cached'.
110
+
111
EXAMPLES
112
--------
113
@@ -142,6 +151,11 @@ Another example:
151
The second .gitignore prevents git from ignoring
152
`arch/foo/kernel/vmlinux.lds.S`.
153
154
+SEE ALSO
155
+--------
156
+linkgit:git-rm[1], linkgit:git-update-index[1],
157
+linkgit:gitrepository-layout[5]
158
+
159
Documentation
160
-------------
161
Documentation by David Greaves, Junio C Hamano, Josh Triplett,