diff options
| author | Chandler Carruth <chandlerc@gmail.com> | 2014-02-28 12:24:18 +0000 |
|---|---|---|
| committer | Chandler Carruth <chandlerc@gmail.com> | 2014-02-28 12:24:18 +0000 |
| commit | 72667d14472314e3830fa03202bcaf967a1c433f (patch) | |
| tree | c31c785b5831375fb252296b09c72de567cbf6ac /docs | |
| parent | 345ca696e7cad5b2141b86b6ec509821997b938f (diff) | |
| download | llvm-72667d14472314e3830fa03202bcaf967a1c433f.tar.gz llvm-72667d14472314e3830fa03202bcaf967a1c433f.tar.bz2 llvm-72667d14472314e3830fa03202bcaf967a1c433f.tar.xz | |
[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.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@202495 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CodingStandards.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/CodingStandards.rst b/docs/CodingStandards.rst index 32e3f70920..4d25c1ddfc 100644 --- a/docs/CodingStandards.rst +++ b/docs/CodingStandards.rst @@ -14,9 +14,9 @@ absolute requirements to be followed in all instances, coding standards are 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: |