summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CodingStandards.rst
Commit message (Collapse)AuthorAgeFilesLines
...
* Document that std::initializer_list is not always available.Peter Collingbourne2014-03-031-0/+3
| | | | | | Differential Revision: http://llvm-reviews.chandlerc.com/D2923 llvm-svn: 202750
* C++11: Beware unnecessary copies with autoDuncan P. N. Exon Smith2014-03-031-0/+21
| | | | | | | | It's easy to copy unintentionally when using 'auto', particularly inside range-based for loops. Best practise is to use 'const&' unless there's a good reason not to. llvm-svn: 202729
* Clarify struct usage guidelinesDuncan P. N. Exon Smith2014-03-031-5/+31
| | | | | | | | The current coding standards restrict the use of struct to PODs, but no one has been following them. This patch updates the standards to clarify when structs are dangerous and describe common practice in LLVM. llvm-svn: 202728
* [C++11] Suggest placing callable arguments as the last argument toChandler Carruth2014-03-021-0/+4
| | | | | | | | facilitate the nice formatting of lambdas passed there. Suggested by Chris during review of my lambda additions, and something I strongly agree with. llvm-svn: 202622
* [C++11] Update the coding standards to provide some important guidanceChandler Carruth2014-03-021-4/+126
| | | | | | | | | | about a few constructs in C++11 that are worth starting off in a consistent manner within the codebase. This will be matched with a change to clang-format's LLVM style which will switch the options to support C++11 and use these conventions. llvm-svn: 202620
* [docs] Fix some Sphinx warnings.Sean Silva2014-03-021-1/+1
| | | | | | | | | | | | | | | | | | | | | | | The docs now build cleanly. Yay! The following warnings were fixed: /home/sean/pg/llvm/llvm/docs/HowToReleaseLLVM.rst:364: WARNING: Enumerated list ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/InAlloca.rst:: WARNING: document isn't included in any toctree /home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short. Supported C++11 Language and Library Features ------------------------------------------- /home/sean/pg/llvm/llvm/docs/CodingStandards.rst:85: WARNING: Title underline too short. Supported C++11 Language and Library Features ------------------------------------------- /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:185: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:565: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/sean/pg/llvm/llvm/docs/GettingStarted.rst:567: WARNING: Block quote ends without a blank line; unexpected unindent. llvm-svn: 202603
* [docs] Update the docs to remove my hedging about C++98 vs. C++11. =]Chandler Carruth2014-03-011-17/+16
| | | | | | | The switch has been thrown. While I'm still watching for any failures or problems with this, the documentation can go ahead and move forward. llvm-svn: 202566
* [docs] Clarify that there isn't much to be done other than watch buildChandler Carruth2014-02-281-0/+5
| | | | | | | | | | | | bots when using the standard library facilities. The missing pieces here aren't always in useful discreet chunks. Fortunately, the missing pieces are few and far between, and we can emulate most of them in our headers as needed. Based on feedback from Lang and Dave. llvm-svn: 202548
* Add more whitespace to fix more bullets.Richard Smith2014-02-281-0/+2
| | | | llvm-svn: 202538
* Add whitespace to try to fix bulleted list.Richard Smith2014-02-281-0/+1
| | | | llvm-svn: 202537
* Fix some links to C++11 feature papers in the Coding StandardsBen Langmuir2014-02-281-16/+16
| | | | llvm-svn: 202532
* [docs] Add a section to the coding standards about languages and such.Chandler Carruth2014-02-281-0/+115
| | | | | | | | | | | | | | | | A lot of this is writing down common knowledge and things often communicated on mailing lists and in discussions. It could live in the Programmer's Manual alternatively, but that felt slightly less well-fitting. It also includes (and was motivated by) the section on the relevant language standards for LLVM and the specific features that will be enabled with the switch to C++11. With this, all of the documentation for the C++11 switch is, I think, in place. I plan to flip the switch RSN. =] llvm-svn: 202497
* [docs] A slight tweak to the intro for the golden rule in the codingChandler Carruth2014-02-281-3/+3
| | | | | | | | | | | | | | | | 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. llvm-svn: 202495
* Revert my commit in r199620 that added sections about namespaces to theChandler Carruth2014-01-201-97/+18
| | | | | | | | | | | | | | | | | | 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. llvm-svn: 199637
* Add some wording to the coding standards to say how to indent namespacesChandler Carruth2014-01-201-1/+45
| | | | | | | | | | | (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. llvm-svn: 199620
* Correct word hyphenationsAlp Toker2013-12-051-1/+1
| | | | | | | This patch tries to avoid unrelated changes other than fixing a few hyphen-related ambiguities and contractions in nearby lines. llvm-svn: 196471
* Revert r189704, which removed the guidance about not duplicating doc comments.Chris Lattner2013-09-011-0/+7
| | | | | | This is under active discussion. llvm-svn: 189730
* Remove the suggestion to not duplicate comments in header andChris Lattner2013-08-301-7/+0
| | | | | | | implementation files. While doc generation systems don't need this, humans do benefit from it. Not everyone reads all code through doxygen. llvm-svn: 189704
* Add the common begin/end naming convention to the coding standard.Rafael Espindola2013-08-071-1/+3
| | | | llvm-svn: 187902
* Coding standards: don't use ``inline`` when defining a function in a classDmitri Gribenko2013-02-041-0/+28
| | | | | | | | | | | | | | | definition Current practice is not to use 'inline' in: class Foo { public: inline void bar() { // ... } }; llvm-svn: 174317
* Fix spellingJoel Jones2013-01-211-1/+1
| | | | llvm-svn: 173103
* docs: Fix long standing linking antipattern.Sean Silva2013-01-111-2/+0
| | | | | | | | | 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. llvm-svn: 172162
* Simplify the coding standards for #include ordering. The ordering is nowChandler Carruth2012-12-021-9/+2
| | | | | | | trivially achievable with an editor. I'll likely check in a silly python script to help with this too. llvm-svn: 169107
* docs: CodingStandards should follow the coding standards.Sean Silva2012-11-171-20/+20
| | | | | | Some variables in code examples were not LikeThis. llvm-svn: 168275
* docs: Add link to HowToSetUpLLVMStyleRTTISean Silva2012-11-171-1/+2
| | | | llvm-svn: 168271
* Suggest llvm_unreachable over assert(0).Jordan Rose2012-10-261-10/+15
| | | | llvm-svn: 166821
* Document current Doxygen use practices in Coding Standards. Mostly it isDmitri Gribenko2012-10-201-9/+134
| | | | | | | | 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. llvm-svn: 166378
* [Docs] Update File Headers section to cover doxygen style file level docs.Michael J. Spencer2012-10-011-8/+11
| | | | llvm-svn: 164964
* Fix && to && in Coding Standards.Jakub Staszak2012-09-301-1/+1
| | | | llvm-svn: 164920
* Add missing 'to' and rephrase an explanation of GCC's assumptions.David Blaikie2012-09-211-4/+4
| | | | | | Wordsmithing by Matt Beaumont-Gay in response to r164389. llvm-svn: 164395
* Document "do not use defaults in covered switch-over-enum" coding standard.David Blaikie2012-09-211-0/+18
| | | | llvm-svn: 164389
* Fix function names in coding style examplesAndrew Trick2012-09-201-4/+4
| | | | llvm-svn: 164311
* Fix static function names in CodingStandards examples.Andrew Trick2012-09-201-6/+6
| | | | | | Try not to violate conventions immediately before explaining them. llvm-svn: 164278
* Coding standards: fix typo: '= deleted' -> '= delete'.Dmitri Gribenko2012-09-181-2/+2
| | | | llvm-svn: 164126
* Add LLVM_DELETED_FUNCTION to coding standards.Craig Topper2012-09-181-0/+28
| | | | llvm-svn: 164101
* Put space after "code-block::".Meador Inge2012-06-201-1/+1
| | | | llvm-svn: 158880
* Removed some left over HTML tags and a '}'.Meador Inge2012-06-201-3/+2
| | | | llvm-svn: 158877
* Sphinxify the CodingStandard documentation.Bill Wendling2012-06-201-0/+1148
llvm-svn: 158786
OpenPOWER on IntegriCloud