From: Kern Sibbald <kern@sibbald.com>
Date: Fri, 26 Feb 2010 08:45:51 +0000 (+0100)
Subject: Add commit keyword documentation from Eric
X-Git-Tag: Release-5.2.1~151
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=29347714f499527dca6f83447353f9612aeaa4d1;p=bacula%2Fdocs

Add commit keyword documentation from Eric
---

diff --git a/docs/manuals/en/developers/generaldevel.tex b/docs/manuals/en/developers/generaldevel.tex
index 33312af4..d3e8d496 100644
--- a/docs/manuals/en/developers/generaldevel.tex
+++ b/docs/manuals/en/developers/generaldevel.tex
@@ -697,10 +697,53 @@ so be conservative in your use of C++ features.
      named bail\_out, and possibly an ok\_out.  See current code
      examples.
 
-\item Malloc and free within a single subroutine.  
+\item malloc and free within a single subroutine.  
 
 \item Comments and global explanations on what your code or  algorithm does. 
 
+\item When committing a fix for a bug, make the comment of the
+following form:
+
+\begin{verbatim}
+Reason for bug fix or other message. Fixes bug #1234 
+\end{verbatim}
+
+It is important to write the {\bf bug #1234} like
+that because our program that automatically pulls messages
+from the git repository to make the ChangeLog looks for that
+pattern.  Obviously the {\bf 1234} should be replaced with
+the number of the bug you actually fixed.
+
+Providing the commit comment line has one of the following
+keywords (or phrases), it will be ignored:
+
+\begin{verbatim}
+  tweak
+  typo
+  cleanup
+  bweb:
+  regress:
+  again
+  .gitignore
+  fix compilation
+  technotes
+  update version
+  update technotes
+  update kernstodo
+  update projects
+  update releasenotes
+  update version
+  update home
+  update release
+  update todo
+  update notes
+  update changelog
+\end{verbatim}
+
+\item Use the following keywords at the beginning of
+a git commit message 
+
+
 \end{itemize}
 
 \subsection{Indenting Standards}