summaryrefslogtreecommitdiff
path: root/docs/CodingStandards.html
Commit message (Collapse)AuthorAge
* apparently variable naming conventions never got added, document theChris Lattner2011-08-12
| | | | | | | prevailing convention. Thanks to Dave Zarzycki for the patch. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@137497 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Introduce cascading style <div> and <p> continued on <h[2-5]>.NAKAMURA Takumi2011-04-23
| | | | | | | | | | | | | | | | | | <h2>Section Example</h2> <div> <!-- h2+div is applied --> <p>Section preamble.</p> <h3>Subsection Example</h3> <p> <!-- h3+p is applied --> Subsection body </p> <!-- End of section body --> </div> FIXME: Care H5 better. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@130040 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Use <Hn> as Heading elements instead of <DIV class="doc_foo">.NAKAMURA Takumi2011-04-18
| | | | | | | | | H1 ... doc_title H2 ... doc_section H3 ... doc_subsection H4 ... doc_subsubsection git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129736 91177308-0d34-0410-b5e6-96231b3b80d8
* docs: Canonicalize URLs.NAKAMURA Takumi2011-04-09
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129181 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix typo.Nick Lewycky2011-02-20
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@126065 91177308-0d34-0410-b5e6-96231b3b80d8
* Grammar corrections and some formatting changes.Bill Wendling2010-12-21
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@122312 91177308-0d34-0410-b5e6-96231b3b80d8
* fix some validation problemsChris Lattner2010-12-10
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121444 91177308-0d34-0410-b5e6-96231b3b80d8
* restructure this for readability, correct the example to follow the public ↵Chris Lattner2010-12-10
| | | | | | ivar name convention git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121443 91177308-0d34-0410-b5e6-96231b3b80d8
* add a rule for enums, patch by Zhanyong Wan!Chris Lattner2010-12-09
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121430 91177308-0d34-0410-b5e6-96231b3b80d8
* Add naming rules to the coding standards.Zhanyong Wan2010-12-02
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@120689 91177308-0d34-0410-b5e6-96231b3b80d8
* forbid rtti and exceptionsChris Lattner2010-11-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@120450 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix formatting nits in the coding standards. Reviewed by clattner.Zhanyong Wan2010-11-23
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119998 91177308-0d34-0410-b5e6-96231b3b80d8
* add some justification for "using namespace llvm;"Chris Lattner2010-11-17
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119544 91177308-0d34-0410-b5e6-96231b3b80d8
* various cleanups and other improvements, patch by Zhanyong Wan!Chris Lattner2010-11-17
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119515 91177308-0d34-0410-b5e6-96231b3b80d8
* update coding standards. Partial specialization is now ok,Chris Lattner2010-11-16
| | | | | | | though possibly not a good idea. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119398 91177308-0d34-0410-b5e6-96231b3b80d8
* describe the preferred approach to silencing 'unused variable warnings' due ↵Chris Lattner2010-11-12
| | | | | | to asserts. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@118863 91177308-0d34-0410-b5e6-96231b3b80d8
* Convert a bunch of uses of 'bytecode' into 'bitcode'. ThisDuncan Sands2010-09-29
| | | | | | | is not everything, but the remaining cases are less trivial. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@115080 91177308-0d34-0410-b5e6-96231b3b80d8
* Revert r103213. It broke several sections of live website.mike-m2010-05-07
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103219 91177308-0d34-0410-b5e6-96231b3b80d8
* Overhauled llvm/clang docs builds. Closes PR6613.mike-m2010-05-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | NOTE: 2nd part changeset for cfe trunk to follow. *** PRE-PATCH ISSUES ADDRESSED - clang api docs fail build from objdir - clang/llvm api docs collide in install PREFIX/ - clang/llvm main docs collide in install - clang/llvm main docs have full of hard coded destination assumptions and make use of absolute root in static html files; namely CommandGuide tools hard codes a website destination for cross references and some html cross references assume website root paths *** IMPROVEMENTS - bumped Doxygen from 1.4.x -> 1.6.3 - splits llvm/clang docs into 'main' and 'api' (doxygen) build trees - provide consistent, reliable doc builds for both main+api docs - support buid vs. install vs. website intentions - support objdir builds - document targets with 'make help' - correct clean and uninstall operations - use recursive dir delete only where absolutely necessary - added call function fn.RMRF which safeguards against botched 'rm -rf'; if any target (or any variable is evaluated) which attempts to remove any dirs which match a hard-coded 'safelist', a verbose error will be printed and make will error-stop. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103213 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix typos in comments.Dan Gohman2010-02-26
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@97257 91177308-0d34-0410-b5e6-96231b3b80d8
* Documentation: Perform automated correction of common typos.Benjamin Kramer2009-10-12
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@83849 91177308-0d34-0410-b5e6-96231b3b80d8
* disuade people from using ostream.Chris Lattner2009-08-23
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79866 91177308-0d34-0410-b5e6-96231b3b80d8
* make owen happy by being explicit.Chris Lattner2009-08-11
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@78688 91177308-0d34-0410-b5e6-96231b3b80d8
* discourage else after "noreturn" statements.Chris Lattner2009-07-28
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77387 91177308-0d34-0410-b5e6-96231b3b80d8
* Tweak, raw_ostream is a ostream, not iostream replacementDaniel Dunbar2009-07-24
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77017 91177308-0d34-0410-b5e6-96231b3b80d8
* CodingStandards: Emphasize use of raw_ostream more.Daniel Dunbar2009-07-24
| | | | | | | - Chris, please approve. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77010 91177308-0d34-0410-b5e6-96231b3b80d8
* fix some wording problems Daniel pointed out, make a example actually real.Chris Lattner2009-07-22
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76751 91177308-0d34-0410-b5e6-96231b3b80d8
* fix typo noticed by DuncanChris Lattner2009-07-22
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76747 91177308-0d34-0410-b5e6-96231b3b80d8
* remove Bill from the author list: his contribution (describing llvm::Ostream Chris Lattner2009-07-22
| | | | | | | and friends) has been removed awhile ago. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76724 91177308-0d34-0410-b5e6-96231b3b80d8
* add some more topics to the coding standards doc:Chris Lattner2009-07-22
| | | | | | | | | | | | * Use Early Exits and 'continue' to Simplify Code * Turn Predicate Loops into Predicate Functions * Spaces Before Parentheses * Namespace Indentation * Anonymous Namespaces git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76723 91177308-0d34-0410-b5e6-96231b3b80d8
* be explicit about making comments real sentences.Chris Lattner2009-07-12
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75406 91177308-0d34-0410-b5e6-96231b3b80d8
* got confused againChris Lattner2009-06-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74514 91177308-0d34-0410-b5e6-96231b3b80d8
* fix some issues Jeff Yasskin noticedChris Lattner2009-06-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74512 91177308-0d34-0410-b5e6-96231b3b80d8
* add a note about re-evaluating end() every time through a loop.Chris Lattner2009-06-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74511 91177308-0d34-0410-b5e6-96231b3b80d8
* tt'ify.Chris Lattner2009-03-23
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@67505 91177308-0d34-0410-b5e6-96231b3b80d8
* VC++ 6.0 is not future work :)Chris Lattner2009-03-23
| | | | | | | Do not recommend llvm::OStream anymore. Use raw_ostream or MemoryBuffer. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@67504 91177308-0d34-0410-b5e6-96231b3b80d8
* So *this* is where all the trailing whitespace in file header comments comeMisha Brukman2009-01-02
| | | | | | | | | from: copy-pasted straight from the coding standards doc! Oh, the irony. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@61586 91177308-0d34-0410-b5e6-96231b3b80d8
* * <div align=center> is not valid HTML 4.01 - removed alignmentMisha Brukman2008-12-11
| | | | | | | | | * <sup> cannot appear inside a <pre> - replaced <pre> with <tt> and <br> * Added standard "Notes" section * Sprinkled fixed-width <tt> tags in a few places for consistency git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60889 91177308-0d34-0410-b5e6-96231b3b80d8
* Global replace of yellow W3C "valid HTML/CSS" icons with blue ones.Misha Brukman2008-12-11
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60880 91177308-0d34-0410-b5e6-96231b3b80d8
* s/A Few Coding Standards/LLVM Coding Standards/gMisha Brukman2008-12-10
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60859 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix spelling mistake.Nick Lewycky2008-11-29
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60250 91177308-0d34-0410-b5e6-96231b3b80d8
* Fix a few HTML tidiness issues.Dan Gohman2008-11-24
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@59966 91177308-0d34-0410-b5e6-96231b3b80d8
* Not that using stream headers other than iostream is allowed.Matthijs Kooijman2008-07-30
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@54209 91177308-0d34-0410-b5e6-96231b3b80d8
* clarify :)Chris Lattner2008-07-08
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@53218 91177308-0d34-0410-b5e6-96231b3b80d8
* Add a standard for control-flow unreachable assertions in functions that returnNick Lewycky2008-05-31
| | | | | | | values, so as to avoid warnings on some platforms. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@51831 91177308-0d34-0410-b5e6-96231b3b80d8
* Don't attribute in file headers anymore. See llvmdev for the Chris Lattner2007-12-29
| | | | | | | discussion of this change. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45409 91177308-0d34-0410-b5e6-96231b3b80d8
* Update links.Chris Lattner2007-11-09
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@43964 91177308-0d34-0410-b5e6-96231b3b80d8
* Clarify some of the iostreams stuff.Bill Wendling2007-11-06
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@43766 91177308-0d34-0410-b5e6-96231b3b80d8
* Validation fixesBill Wendling2007-09-22
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@42229 91177308-0d34-0410-b5e6-96231b3b80d8
* Subversionify the documentation.Reid Spencer2007-07-09
| | | | git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@38442 91177308-0d34-0410-b5e6-96231b3b80d8
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-03 07:47:09 +0000