Differences

This shows you the differences between two versions of the page.

--- devel:git-commit-guidelines [2009/04/16 13:58]
andrei
+++ devel:git-commit-guidelines [2009/04/16 14:09] (current)
andrei
@@ Line 10: / Line 10: @@
   * then one empty line
   * then a more detailed description
+Think of the first line as of an email "Subject" line. In fact it will be used as "Subject" in the generated commit mails and it will also be used when generating the Changelog (e.g. git log --pretty=oneline).
+Please start always with the prefix of the subsystem that is modified by the commit
+(e.g.: "core: typo fixes", "tcp: stun fixes", "mem: faster malloc", "module_name: support for foo", "lib_name: critical bug fix").
+Examples:
+<code>
+usrloc: fixed name conflict
+ - destroy_avps() renamed to reg_destroy_avps() to avoid conflicts
+   with the usr_avp.h version.
+</code>
+<code>
+core: loadpath can now use a list of directories
+- loadpath can use a list of directories separated by ':',
+  e.g.: loadpath "modules:modules_s:modules_k".
+  First match wins (e.g. for loadmodule "textops" if
+  modules/textops.so or modules/textops/textops.so exists, it will
+  be loaded and the search will stop).
+</code>
 See:
@@ Line 22: / Line 43: @@
 ===== Core Commits =====
-  * prefix the first line of the commit message with "core:"
+  * prefix the first line of the commit message with "core:", or with the subsystem prefix (e.g. "tcp", "dns", "mem", "script" a.s.o).
 ===== Module Commits =====

Trace: