]> git.sur5r.net Git - openocd/commitdiff
HACKING: add tip on how to write comments
authorØyvind Harboe <oyvind.harboe@zylin.com>
Sun, 12 Jun 2011 09:33:37 +0000 (11:33 +0200)
committerØyvind Harboe <oyvind.harboe@zylin.com>
Sun, 12 Jun 2011 09:33:37 +0000 (11:33 +0200)
HACKING

diff --git a/HACKING b/HACKING
index 5718798dfb19513036149ed3704fec62247b4034..6e4fc4b3323d183d7389fad34a8a890e8f799995 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -34,6 +34,13 @@ while(!done) {
 
 TIP! use "git add ." before commit to add new files.
 
 
 TIP! use "git add ." before commit to add new files.
 
+--- example comment, notice the short first line w/topic ---
+topic: short comment
+<blank line>
+longer comments over several
+lines...
+-----
+
 3. Next you need to make sure that your patches
 are on top of the latest stuff on the server and
 that there are no conflicts.
 3. Next you need to make sure that your patches
 are on top of the latest stuff on the server and
 that there are no conflicts.