summaryrefslogtreecommitdiff
path: root/docs/CodingStandards.rst
Commit message (Collapse)AuthorAge
* Revert my commit in r199620 that added sections about namespaces to theChandler Carruth2014-01-20
| | | | | | | | | | | | | | | | | | coding standards, and instead fix the existing section. Thanks to Daniel Jasper for pointing out we already had a section devoted to this topic. Instead of adding sections, just hack on this section some. Also fix the example in the anonymous namespace section below it to agree with the new advice. As a re-cap, this switches the LLVM preferred style to never indent namespaces. Having two approaches just led to endless (and utterly pointless) debates about what was "small enough". This wasn't helping anyone. The no-indent rule is easy to understand and doesn't really make anything harder to read. Moreover, with tools like clang-format it is considerably nicer to have simple consistent rules. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@199637 91177308-0d34-0410-b5e6-96231b3b80d8
* Add some wording to the coding standards to say how to indent namespacesChandler Carruth2014-01-20
| | | | | | | | | | | (and to mention namespace ending comments). This is based on a quick discussion on the developer mailing list where there was essentially no objections to a simple and consistent rule. This should avoid future debates about whether or not a namespace is "big enough" to indent. It also matches clang-format's current behavior with LLVM source code which hasn't really seen any opposition in code reviews that I spot checked. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@199620 91177308-0d34-0410-b5e6-96231b3b80d8
* Correct word hyphenationsAlp Toker2013-12-05
| | | | | | | This patch tries to avoid unrelated changes other than fixing a few hyphen-related ambiguities and contractions in nearby lines. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@196471 91177308-0d34-0410-b5e6-96231b3b80d8
* Revert r189704, which removed the guidance about not duplicating doc comments.Chris Lattner2013-09-01
| | | | | | | This is under active discussion. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189730 91177308-0d34-0410-b5e6-96231b3b80d8
* Remove the suggestion to not duplicate comments in header andChris Lattner2013-08-30
| | | | | | | | implementation files. While doc generation systems don't need this, humans do benefit from it. Not everyone reads all code through doxygen. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189704 91177308-0d34-0410-b5e6-96231b3b80d8
* Add the common begin/end naming convention to the coding standard.Rafael Espindola2013-08-07
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@187902 91177308-0d34-0410-b5e6-96231b3b80d8
* Coding standards: don't use ``inline`` when defining a function in a classDmitri Gribenko2013-02-04
| | | | | | | | | | | | | | | | definition Current practice is not to use 'inline' in: class Foo { public: inline void bar() { // ... } }; git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@174317 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix spellingJoel Jones2013-01-21
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@173103 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Fix long standing linking antipattern.Sean Silva2013-01-11
| | | | | | | | | Before we learned about :doc:, we used :ref: and put a dummy link at the top of each page. Don't do that anymore. This fixes PR14891 as a special case. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@172162 91177308-0d34-0410-b5e6-96231b3b80d8
* Simplify the coding standards for #include ordering. The ordering is nowChandler Carruth2012-12-02
| | | | | | | trivially achievable with an editor. I'll likely check in a silly python script to help with this too. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169107 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: CodingStandards should follow the coding standards.Sean Silva2012-11-17
| | | | | | Some variables in code examples were not LikeThis. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168275 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Add link to HowToSetUpLLVMStyleRTTISean Silva2012-11-17
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168271 91177308-0d34-0410-b5e6-96231b3b80d8
* Suggest llvm_unreachable over assert(0).Jordan Rose2012-10-26
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@166821 91177308-0d34-0410-b5e6-96231b3b80d8
* Document current Doxygen use practices in Coding Standards. Mostly it isDmitri Gribenko2012-10-20
| | | | | | | | | obvious stuff and most new code being committed conforms to that. Some old code does not; this might cause confusion and this is the motivation to document the correct guidelines. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@166378 91177308-0d34-0410-b5e6-96231b3b80d8
* [Docs] Update File Headers section to cover doxygen style file level docs.Michael J. Spencer2012-10-01
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164964 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix && to && in Coding Standards.Jakub Staszak2012-09-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164920 91177308-0d34-0410-b5e6-96231b3b80d8
* Add missing 'to' and rephrase an explanation of GCC's assumptions.David Blaikie2012-09-21
| | | | | | Wordsmithing by Matt Beaumont-Gay in response to r164389. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164395 91177308-0d34-0410-b5e6-96231b3b80d8
* Document "do not use defaults in covered switch-over-enum" coding standard.David Blaikie2012-09-21
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164389 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix function names in coding style examplesAndrew Trick2012-09-20
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164311 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix static function names in CodingStandards examples.Andrew Trick2012-09-20
| | | | | | Try not to violate conventions immediately before explaining them. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164278 91177308-0d34-0410-b5e6-96231b3b80d8
* Coding standards: fix typo: '= deleted' -> '= delete'.Dmitri Gribenko2012-09-18
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164126 91177308-0d34-0410-b5e6-96231b3b80d8
* Add LLVM_DELETED_FUNCTION to coding standards.Craig Topper2012-09-18
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@164101 91177308-0d34-0410-b5e6-96231b3b80d8
* Put space after "code-block::".Meador Inge2012-06-20
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158880 91177308-0d34-0410-b5e6-96231b3b80d8
* Removed some left over HTML tags and a '}'.Meador Inge2012-06-20
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158877 91177308-0d34-0410-b5e6-96231b3b80d8
* Sphinxify the CodingStandard documentation.Bill Wendling2012-06-20
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158786 91177308-0d34-0410-b5e6-96231b3b80d8
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-01 04:17:23 +0000