From cf1418e9a85013bbf8dbcc2d2e9985695993d9f4 Mon Sep 17 00:00:00 2001 From: Andreas Fritiofson Date: Sat, 29 Dec 2012 00:14:44 +0100 Subject: [PATCH] doc: Clarify the topic field in the commit comment template MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: Iea1f3b665b011ca3748800048039d3f6b33d7756 Signed-off-by: Andreas Fritiofson Reviewed-on: http://openocd.zylin.com/1101 Reviewed-by: Øyvind Harboe Reviewed-by: Tomasz CEDRO Reviewed-by: Spencer Oliver Tested-by: Spencer Oliver --- HACKING | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/HACKING b/HACKING index 658aa76b5..2bd311427 100644 --- a/HACKING +++ b/HACKING @@ -102,15 +102,18 @@ while(!done) { } @endcode @b TIP! use "git add ." before commit to add new files. + + Comment template, notice the short first line w/topic. The topic field + should identify the main part or subsystem the patch touches. Check + git log for examples. @code ---- example comment, notice the short first line w/topic --- -topic: short comment +topic: Short comment -longer comments over several -lines... +Longer comments over several lines, explaining (where applicable) the +reason for the patch and the general idea the solution is based on, +any major design decisions, etc... Signed-off-by: ... ------ @endcode -# Next you need to make sure that your patches are on top of the latest stuff on the server and