Consensus was reached to remove editor-specific globs from .gitignore.

In a highly overengineered discussion out of scope with the actual breadth
of this very minor issue, everyone has come to the conclusion that
editor-specific globs don't really belong in the project's .gitignore,
given that git permits a global-level ignore file for users.

Instead, a HACKING file is herein added, with its first entry to explain
how developers can set the own global gitignore.

Signed-off-by: Bradley M. Kuhn <bkuhn@ebb.org>

diff --git a/.gitignore b/.gitignore
index 61d5c15..d9e24bf 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,10 +1,3 @@
-# Hide temp files
-*.swp
-
-# Hide emacs autosave/backup files
-#*#
-
-*~
 # Hide built objects
 *.[oa]
 *.la
@@ -332,3 +325,4 @@ Open-ILS/xul/staff_client/evergreen_staff_client.tar.bz2
 Open-ILS/xul/staff_client/xulrunner-3.6.25.en-US.linux-i686.tar.bz2
 Open-ILS/xul/staff_client/xulrunner/
 README.html
+HACKING.html

diff --git a/HACKING b/HACKING
new file mode 100644 (file)
index 0000000..f95ab12
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,57 @@
+HACKING File for Evergreen
+==========================
+:toc:
+:numbered:
+
+
+Git Ignores
+-----------
+
+The +.gitignore+ file for the project level should only have files that
+are generated by the build or install processes of Evergreen itself.
+
+Often, users of various text editors may want to ignore the backup or
+autosave files.  Evergreen recommends putting this not in the project's
+.gitignore, but into the global ignore files for their git configuration.
+Below is how to do this for various editors.
+
+Creating A Global Git ignore file
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A useful tutorial on this issue can be found
+http://programblings.com/2008/10/22/git-global-ignores/[in this blog
+post].  The basic, command, however, is as follows:
+
+[source,bash]
+------------------------------------------------------------------------------
+git config --global core.excludesfile /path/to/my/global/gitignore
+------------------------------------------------------------------------------
+
+Many people like to use +~/.gitignore+ for +/path/to/my/global/gitignore+.
+
+Git Ignore Emacs Autosave/backup files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+To ignore Emacs autosave/backup files, put the following lines in your
++/path/to/my/global/gitignore+ file.
+
+------------------------------------------------------------------------------
+*~
+\#*#
+------------------------------------------------------------------------------
+
+Note the need of a backslash before the pound sign above, which is needed
+since pound usually is a comment in a +gitignore+ file.
+
+Git Ignore Vim Autosave/backup files
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To ignore vim autosave files, put the following lines in your
++/path/to/my/global/gitignore+ file.
+------------------------------------------------------------------------------
+*.swp
+------------------------------------------------------------------------------
+
+Note that vim sometimes creates more files of similar names, so you may want this:
+
+------------------------------------------------------------------------------
+*.s[vw][a-z]
+------------------------------------------------------------------------------