From: Øyvind Harboe <oyvind.harboe@zylin.com>
Date: Sun, 12 Jun 2011 09:33:37 +0000 (+0200)
Subject: HACKING: add tip on how to write comments
X-Git-Tag: v0.5.0-rc1~22
X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=1b0862c189f8db70f65e0eeabb749580d71e0e97

HACKING: add tip on how to write comments
---

diff --git a/HACKING b/HACKING
index 5718798dfb..6e4fc4b332 100644
--- a/HACKING
+++ b/HACKING
@@ -34,6 +34,13 @@ while(!done) {
 
 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.