Consensus was reached to remove editor-specific globs from .gitignore.
authorBradley M. Kuhn <bkuhn@ebb.org>
Sat, 28 Apr 2012 13:39:12 +0000 (09:39 -0400)
committerDan Scott <dan@coffeecode.net>
Wed, 9 May 2012 04:39:27 +0000 (00:39 -0400)
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>
Signed-off-by: Dan Scott <dan@coffeecode.net>
.gitignore
HACKING [new file with mode: 0644]

index a530800..d9e24bf 100644 (file)
@@ -1,6 +1,3 @@
-# Hide temp files
-*.swp
-
 # Hide built objects
 *.[oa]
 *.la
@@ -328,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..f270c58
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,67 @@
+HACKING File for Evergreen
+==========================
+:toc:
+:numbered:
+
+Contributing
+------------
+A
+http://evergreen-ils.org/dokuwiki/doku.php?id=contributing[tutorial for contributing to Evergreen is on the Evergreen Wiki].
+
+Git
+---
+
+The
+http://evergreen-ils.org/dokuwiki/doku.php?id=dev:git[Git workflow used by the project is documented on the Evergreen Wiki].
+
+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]
+------------------------------------------------------------------------------