From: Tomi Ollila <tomi.ollila@iki.fi>
To: <notmuch@notmuchmail.org>
Subject: [PATCH] uncrustify.cfg: comments and more types
Date: Wed, 25 Jan 2012 23:37:45 +0200
Message-Id: <1327527465-10321-1-git-send-email-tomi.ollila@iki.fi>
Cc: Tomi Ollila <tomi.ollila@iki.fi>
Precedence: list

Changes to devel/uncrustify.cfg:

* Updated header comment to state this is config file for *notmuch*.
* Mentioned in header commit that uncrustify version 0.59 required.
* Use tabs to indent/align comments.
* Added comment about the reason of 'type' keyword used.
* Added some more custom types woth 'type' keyword.
* Have (every) multiline comment lines start with '*'.
---
 devel/uncrustify.cfg |   23 +++++++++++++++--------
 1 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/devel/uncrustify.cfg b/devel/uncrustify.cfg
index d8075ba..92bb29b 100644
--- a/devel/uncrustify.cfg
+++ b/devel/uncrustify.cfg
@@ -1,13 +1,15 @@
 #
-# uncrustify config file for the linux kernel
+# Uncrustify config file for notmuch.
+# Based on uncrustify config file for the linux kernel
 #
 # $Id: linux-indent.cfg 488 2006-09-09 12:44:38Z bengardner $
 # Taken from the uncrustify distribution under license (GPL2+)
 #
-# sample usage:
+# Sample usage:
 #        uncrustify --replace -c uncrustify.cfg foo.c
 #
-#
+# Note: for proper output, uncrustify version 0.59 is required.
+# (without indent_cmt_with_tabs this may work ok with 0.58 (and possibly older)
 
 indent_with_tabs	= 2		# 1=indent to level only, 2=indent with tabs
 align_with_tabs		= TRUE		# use tabs to align
@@ -18,6 +20,8 @@ indent_columns		= 4
 
 indent_label		= -2		# pos: absolute col, neg: relative column
 
+indent_cmt_with_tabs	= true		# use tabs to indent/align comments
+
 #
 # inter-symbol newlines
 #
@@ -54,11 +58,14 @@ nl_after_struct = 0
 # mod_full_brace_do	= remove	# "do a--; while ();" vs "do { a--; } while ();"
 # mod_full_brace_while	= remove	# "while (a) a--;" vs "while (a) { a--; }"
 
-#
-# Extra types used in notmuch source.
-# (add more on demand)
 
-type GMimeObject mime_node_t
+# In case some custom types aren't detected properly by uncrustify
+# add those to this section below. For example there are cases where
+# uncrustify doesn't know whether a 'token' is part of pointer type
+# or left operand of a binary multiplication operation. 
+
+type GMimeObject GMimeCryptoContext GMimeCipherContext
+type mime_node_t notmuch_message_t
 
 #
 # inter-character spacing options
@@ -107,7 +114,6 @@ align_right_cmt_span	= 8		# align comments span this much in func
 # align_pp_define_span	= 8;
 # align_pp_define_gap	= 4;
 
-# cmt_star_cont		= FALSE
+cmt_star_cont		= true
 
 # indent_brace		= 0
-- 
1.7.8.2