[libdmapsharing] Add notes about indent to coding standards documentation Signed-off-by: W. Michael Petullo <mike fly



commit 430c89f1499962b4a36c1496ab98855d359d1520
Author: W. Michael Petullo <mike flyn org>
Date:   Fri Mar 4 13:11:50 2011 -0600

    Add notes about indent to coding standards documentation
    Signed-off-by: W. Michael Petullo <mike flyn org>

 docs/coding-standards.xml |   12 ++++++++++++
 1 files changed, 12 insertions(+), 0 deletions(-)
---
diff --git a/docs/coding-standards.xml b/docs/coding-standards.xml
index 9f3dcc3..1b0f66b 100644
--- a/docs/coding-standards.xml
+++ b/docs/coding-standards.xml
@@ -52,6 +52,12 @@ void foo (void)
 </programlisting>
 	</listitem>
 
+	<listitem>Place a semicolon following function-like preprocessor macros because the lack of one might confuse tools such as <application>indent</application> (even if the semicolon is actually repetitive):
+<programlisting>
+CPPFUNC(foo);
+</programlisting>
+	</listitem>
+
 	<listitem>Perform a Git commit after finishing a single
 	task</listitem>
 
@@ -71,6 +77,12 @@ characters long.
 
 	<listitem>Use GObject conventions for things not covered here</listitem>
 
+	<listitem>You may use the following indent command to format libdmapsharing code:
+<programlisting>
+indent -i8 -bad -bap -br -ce -d0 -ndj -lp -pcs -psl -sc -sob foo.c
+</programlisting>
+	</listitem>
+
 </itemizedlist>
 	</refsect1>
 </refentry>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]