[llvm] r202495 - [docs] A slight tweak to the intro for the golden rule in the coding

Chandler Carruth chandlerc at gmail.com
Fri Feb 28 04:24:18 PST 2014


Author: chandlerc
Date: Fri Feb 28 06:24:18 2014
New Revision: 202495

URL: http://llvm.org/viewvc/llvm-project?rev=202495&view=rev
Log:
[docs] A slight tweak to the intro for the golden rule in the coding
standards.

It claims the document intentionally doesn't give fixed standards for
brace placement or spacing, and then the document goes on to do
precisely that in several places. Instead, try to highlight that even
these rules are simply *guidance* which may be trumped by some other
circumstance or the local conventions of code.

I'm not trying to change the thrust of this part of the document, and if
folks think this does so, I'm happy to re-wordsmith it. I just don't
want it to be so self-contradicting.

Modified:
    llvm/trunk/docs/CodingStandards.rst

Modified: llvm/trunk/docs/CodingStandards.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CodingStandards.rst?rev=202495&r1=202494&r2=202495&view=diff
==============================================================================
--- llvm/trunk/docs/CodingStandards.rst (original)
+++ llvm/trunk/docs/CodingStandards.rst Fri Feb 28 06:24:18 2014
@@ -14,9 +14,9 @@ absolute requirements to be followed in
 particularly important for large-scale code bases that follow a library-based
 design (like LLVM).
 
-This document intentionally does not prescribe fixed standards for religious
-issues such as brace placement and space usage.  For issues like this, follow
-the golden rule:
+While this document may provide guidance for some mechanical formatting issues,
+whitespace, or other "microscopic details", these are not fixed standards.
+Always follow the golden rule:
 
 .. _Golden Rule:
 





More information about the llvm-commits mailing list