[Xen-changelog] [xen master] CODING_STYLE: Allow single-sentence comments without full stops

[patchbot@xxxxxxx]

commit 78ac45c9af9374ccce53e5e150872ad40cf33706
Author:     George Dunlap <george.dunlap@xxxxxxxxxx>
AuthorDate: Mon Aug 8 11:07:46 2016 +0100
Commit:     George Dunlap <george.dunlap@xxxxxxxxxx>
CommitDate: Mon Aug 8 11:08:30 2016 +0100

    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 <george.dunlap@xxxxxxxxxx>
    Acked-by: Ian Jackson <ian.jackson@xxxxxxxxxx>
---
 CODING_STYLE | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/CODING_STYLE b/CODING_STYLE
index 95842e3..4c3b53a 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 '*'.
--
generated by git-patchbot for /home/xen/git/xen.git#master

_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxx
https://lists.xenproject.org/xen-changelog