hal: Branch 'master'

[David Zeuthen]

 HACKING |   77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 files changed, 74 insertions(+), 3 deletions(-)

New commits:
diff-tree c88613217759651022885ea99be91af46c0d6391 (from ec201f8ef1428ed2e1ad1298f9dbb9210b928acc)
Author: David Zeuthen <davidz at redhat.com>
Date:   Sat Jul 29 12:55:35 2006 -0400

    update HACKING file to mention git and commit format

diff --git a/HACKING b/HACKING
index 50a21a6..0837abd 100644
--- a/HACKING
+++ b/HACKING
@@ -1,13 +1,84 @@
 
+SCM
+===
+
+ - anonymous checkouts
+
+   $ git clone git://git.freedesktop.org/git/hal.git
+
+ - checkouts if you got an ssh account on fd.o (username@ is optional)
+
+   $ git clone ssh://[username@]git.freedesktop.org/git/hal.git
+
+ - commit to local repository
+
+   $ git commit -a
+
+ - push local repository to master repository at fd.o (remember most patches
+   requires review at the mailing list)
+
+   $ git push
+
+ - pull changes from master repository at fd.o
+
+   $ git pull
+
+ - diff of working tree versus local repository
+
+   $ git diff
+
+ - diff of local repository vs. master repository at fd.o
+
+   $ git diff origin HEAD
+
+ - influential environment variables (set these in e.g. .bash_profile)
+
+   export GIT_AUTHOR_NAME='Your Full Name'
+   export GIT_COMMITTER_NAME='Your Full Name'
+   export GIT_COMMITTER_EMAIL=youremail at domain.net
+   export GIT_AUTHOR_EMAIL=youremail at domain.net
+
+ - see also
+
+    http://www.kernel.org/pub/software/scm/git/docs/
+
+
+Committing code
+===
+
+ - Commit messages should be of the form (the five lines between the
+   lines starting with ===)
+
+=== begin example commit ===
+short explanation of the commit
+
+Longer explanation explaining exactly what's changed, whether any
+external or private interfaces changed, what bugs were fixed (with bug
+tracker reference if applicable) and so forth. Be concise but not too brief.
+=== end example commit ===
+
+ - Always add a brief description of the commit to the _first_ line of
+   the commit and terminate by two newlines (it will work without the
+   second newline, but that is not nice for the interfaces). 
+
+ - First line (the brief description) must only be one sentence and
+   must not start with a capital letter. Don't use a trailing period
+   either.
+
+ - The main description (the body) is normal prose and should use normal
+   punctuation and capital letters where appropriate. Normally, for patches
+   sent to a mailing list it's copied from there.
+
+ - When committing code on behalf of others use the --author option, e.g.
+   git commit -a --author "Joe Coder <joe at coder.org>"
+
 Coding Style
 ===
 
  - Please follow the coding style already used - it's not a must, but it's
    nice to have consistency.
 
- - Write docs for all functions and structs and so on. try
-   "doxygen Doxyfile" prior to commit and be sure there are no
-   warnings printed.
+ - Write docs for all functions and structs and so on. We use gtkdoc format.
 
  - All external interfaces (network protocols, file formats, etc.)
    should have documented specifications sufficient to allow an