hgignore.5: expanded description
authorMartin Geisler <mg@lazybytes.net>
Tue, 21 Jul 2009 12:06:32 +0200
changeset 9182 3a319bc8906d
parent 9177 41bc92142f06
child 9183 d0225fa2f6c4
child 9185 d9a2e6327949
child 9193 52de439b8d99
hgignore.5: expanded description - explain that .hgignore must be created manually - hint that it is typically put under revision control
doc/hgignore.5.txt
--- a/doc/hgignore.5.txt	Mon Jul 20 19:15:44 2009 -0500
+++ b/doc/hgignore.5.txt	Tue Jul 21 12:06:32 2009 +0200
@@ -18,6 +18,14 @@
 DESCRIPTION
 -----------
 
+The working directory of a Mercurial repository will often contain
+files that should not be tracked by Mercurial. These include backup
+files created by editors and build products created by compilers.
+These files can be ignored by listing them in a `.hgignore` file in
+the root of the working directory. The `.hgignore` file must be
+created manually. It is typically put under version control, so that
+the settings will propagate to other repositories with push and pull.
+
 An untracked file is ignored if its path relative to the repository
 root directory, or any prefix path of that path, is matched against
 any pattern in `.hgignore`.