From: Junio C Hamano <gitster@pobox.com>
Date: Tue, 3 Dec 2013 19:41:43 +0000 (-0800)
Subject: Merge branch 'jj/doc-markup-hints-in-coding-guidelines'
X-Git-Tag: v1.9-rc0~106
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/f0c9253ef9b8ddbb81ad2a060db52fd5a646137f

Merge branch 'jj/doc-markup-hints-in-coding-guidelines'

* jj/doc-markup-hints-in-coding-guidelines:
State correct usage of literal examples in man pages in the coding standards
---

f0c9253ef9b8ddbb81ad2a060db52fd5a646137f
diff --cc Documentation/CodingGuidelines
index a600e35c81,4b9d59e7ae..ef67b53f72
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@@ -250,19 -242,13 +250,21 @@@ Writing Documentation
   processed into HTML and manpages (e.g. git.html and git.1 in the
   same directory).
  
 + The documentation liberally mixes US and UK English (en_US/UK)
 + norms for spelling and grammar, which is somewhat unfortunate.
 + In an ideal world, it would have been better if it consistently
 + used only one and not the other, and we would have picked en_US
 + (if you wish to correct the English of some of the existing
 + documentation, please see the documentation-related advice in the
 + Documentation/SubmittingPatches file).
 +
   Every user-visible change should be reflected in the documentation.
   The same general rule as for code applies -- imitate the existing
-  conventions.  A few commented examples follow to provide reference
-  when writing or modifying command usage strings and synopsis sections
-  in the manual pages:
+  conventions.
+ 
+  A few commented examples follow to provide reference when writing or
+  modifying command usage strings and synopsis sections in the manual
+  pages:
  
   Placeholders are spelled in lowercase and enclosed in angle brackets:
     <file>