From: George Dunlap Date: Mon, 8 Aug 2016 10:07:46 +0000 (+0100) Subject: CODING_STYLE: Allow single-sentence comments without full stops X-Git-Tag: archive/raspbian/4.8.0-1+rpi1~1^2~600 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=78ac45c9af9374ccce53e5e150872ad40cf33706;p=xen.git CODING_STYLE: Allow single-sentence comments without full stops One of the common ways in which contributors trip up over the CODING_STYLE guides is by not putting a full stop at the end of a comment when there is only a single sentence. Calling these out is a waste of everybody's time: The full stop at the end of a comment with a single sentence (or a single phrase) adds absolutely nothing to the legibility of the code. Modify CODING_STYLE to allow comments with a single sentence or sentence fragment to either have a full stop or not, while making it clear that comments with multiple sentences must have a full stop at the end of each sentence. Signed-off-by: George Dunlap Acked-by: Ian Jackson --- diff --git a/CODING_STYLE b/CODING_STYLE index 95842e39c9..4c3b53a754 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -93,7 +93,9 @@ Comments Only C style /* ... */ comments are to be used. C++ style // comments should not be used. Multi-word comments should begin with a capital -letter and end with a full stop. +letter. Comments containing a single sentence may end with a full +stop; comments containing several sentences must have a full stop +after each sentence. Multi-line comment blocks should start and end with comment markers on separate lines and each line should begin with a leading '*'.