From: Michael Meffie <mmeffie@sinenomine.net>
Date: Sat, 6 Aug 2016 16:57:59 +0000 (-0400)
Subject: CODING: update style guide for multiline comments
X-Git-Tag: upstream/1.8.0_pre1^2~55
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=c17d14223044936a5de5007052eff3488350e9d4;p=packages%2Fo%2Fopenafs.git

CODING: update style guide for multiline comments

Document the preferred style for multiple line comment blocks and give an
example.

Change-Id: I73d6183da9014a943316e5aea1d43be2acc81ad7
Reviewed-on: https://gerrit.openafs.org/12361
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: Benjamin Kaduk <kaduk@mit.edu>
---

diff --git a/CODING b/CODING
index 6a1af0565..f8a3fd4f2 100644
--- a/CODING
+++ b/CODING
@@ -83,6 +83,16 @@ Suggested compiler flags:
 		(You might not want the -fd, it isn't really useful, just complains about the
 		K&R style functions, but -v gives useful info.)
 
+Multiple line comment blocks should begin with only /* on one line and end with
+only */ on one line.
+
+Example:
+
+	/*
+	 * Multiple line comment blocks should be formatted
+	 * like this example.
+	 */
+
 
 Dependencies required to build OpenAFS from source
 --------------------------------------------------