[Pkg-ocaml-maint-commits] r5467 - /trunk/projects/git-guide/notes.mdwn

[zack at users.alioth.debian.org]

Author: zack
Date: Thu Apr 10 11:51:05 2008
New Revision: 5467

URL: http://svn.debian.org/wsvn/?sc=1&rev=5467
Log:
add info on how to ignore build cruft

Modified:
    trunk/projects/git-guide/notes.mdwn

Modified: trunk/projects/git-guide/notes.mdwn
URL: http://svn.debian.org/wsvn/trunk/projects/git-guide/notes.mdwn?rev=5467&op=diff
==============================================================================
--- trunk/projects/git-guide/notes.mdwn (original)
+++ trunk/projects/git-guide/notes.mdwn Thu Apr 10 11:51:05 2008
@@ -18,6 +18,34 @@
     <snip>
     commit 61521da701a50ad6a82356a61fab17a4694bb7b5
     Author: Stefano Zacchiroli <zack at upsilon.cc>
+
+Ignoring cruft
+--------------
+
+Since with git we will be keeping both upstream sources and Debian packaging
+metadata in the same repository, we will be more often be faced with binary
+objects generated as part of the compilation than before.  As usual with all
+$VCSs, we do not want to commit stuff like `*.cmo`, nor to have our $VCS bother
+us with their presence.
+
+To ignore typical OCaml generated objects place a file .gitignore in the *root*
+of your repository, containing something like:
+
+    $ cat .gitignore
+    *.a
+    *.cma
+    *.cmi
+    *.cmo
+    *.cmx
+    *.cmxa
+    *.o
+    *.so
+
+it will recursively match file names matching those wildcard patterns everywhere
+in the repository. For fine-grained tuning see the manpage `gitignore (5)`. Then
+you can commit that file so that other people cloning the repository will
+benefit from the ignores.  You can add .gitignore files mode down in the
+directory hierarchy to ignore files only in a specific sub-tree.
 
 Common action recipes
 =====================