aboutsummaryrefslogtreecommitdiff
path: root/docs/CodingStandards.html
AgeCommit message (Collapse)Author
2012-06-20Sphinxify the CodingStandard documentation.Bill Wendling
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158786 91177308-0d34-0410-b5e6-96231b3b80d8
2012-04-19[docs] Update HTML pages to refer to CSS in a way that works locally and ↵Daniel Dunbar
with Sphinx. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155153 91177308-0d34-0410-b5e6-96231b3b80d8
2012-03-27llvm/docs/*.html: Fix markups.NAKAMURA Takumi
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@153508 91177308-0d34-0410-b5e6-96231b3b80d8
2012-03-16clarify the coding standards a bit.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@152957 91177308-0d34-0410-b5e6-96231b3b80d8
2012-02-08add an explicit section on static constructors.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@150037 91177308-0d34-0410-b5e6-96231b3b80d8
2011-10-31docs/*.html: Appease W3C Checker to add "charset=utf-8".NAKAMURA Takumi
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@143348 91177308-0d34-0410-b5e6-96231b3b80d8
2011-08-12apparently variable naming conventions never got added, document theChris Lattner
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
2011-04-23docs: Introduce cascading style <div> and <p> continued on <h[2-5]>.NAKAMURA Takumi
<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
2011-04-18docs: Use <Hn> as Heading elements instead of <DIV class="doc_foo">.NAKAMURA Takumi
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
2011-04-09docs: Canonicalize URLs.NAKAMURA Takumi
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129181 91177308-0d34-0410-b5e6-96231b3b80d8
2011-02-20Fix typo.Nick Lewycky
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@126065 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-21Grammar corrections and some formatting changes.Bill Wendling
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@122312 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-10fix some validation problemsChris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121444 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-10restructure this for readability, correct the example to follow the public ↵Chris Lattner
ivar name convention git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121443 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-09add a rule for enums, patch by Zhanyong Wan!Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121430 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-02Add naming rules to the coding standards.Zhanyong Wan
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@120689 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-30forbid rtti and exceptionsChris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@120450 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-23Fix formatting nits in the coding standards. Reviewed by clattner.Zhanyong Wan
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119998 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-17add some justification for "using namespace llvm;"Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119544 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-17various cleanups and other improvements, patch by Zhanyong Wan!Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119515 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-16update coding standards. Partial specialization is now ok,Chris Lattner
though possibly not a good idea. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119398 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-12describe the preferred approach to silencing 'unused variable warnings' due ↵Chris Lattner
to asserts. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@118863 91177308-0d34-0410-b5e6-96231b3b80d8
2010-09-29Convert a bunch of uses of 'bytecode' into 'bitcode'. ThisDuncan Sands
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
2010-05-07Revert r103213. It broke several sections of live website.mike-m
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103219 91177308-0d34-0410-b5e6-96231b3b80d8
2010-05-06Overhauled llvm/clang docs builds. Closes PR6613.mike-m
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
2010-02-26Fix typos in comments.Dan Gohman
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@97257 91177308-0d34-0410-b5e6-96231b3b80d8
2009-10-12Documentation: Perform automated correction of common typos.Benjamin Kramer
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@83849 91177308-0d34-0410-b5e6-96231b3b80d8
2009-08-23disuade people from using ostream.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79866 91177308-0d34-0410-b5e6-96231b3b80d8
2009-08-11make owen happy by being explicit.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@78688 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-28discourage else after "noreturn" statements.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77387 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-24Tweak, raw_ostream is a ostream, not iostream replacementDaniel Dunbar
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77017 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-24CodingStandards: Emphasize use of raw_ostream more.Daniel Dunbar
- Chris, please approve. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77010 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-22fix some wording problems Daniel pointed out, make a example actually real.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76751 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-22fix typo noticed by DuncanChris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76747 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-22remove Bill from the author list: his contribution (describing llvm::Ostream Chris Lattner
and friends) has been removed awhile ago. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76724 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-22add some more topics to the coding standards doc:Chris Lattner
* 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
2009-07-12be explicit about making comments real sentences.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75406 91177308-0d34-0410-b5e6-96231b3b80d8
2009-06-30got confused againChris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74514 91177308-0d34-0410-b5e6-96231b3b80d8
2009-06-30fix some issues Jeff Yasskin noticedChris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74512 91177308-0d34-0410-b5e6-96231b3b80d8
2009-06-30add a note about re-evaluating end() every time through a loop.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74511 91177308-0d34-0410-b5e6-96231b3b80d8
2009-03-23tt'ify.Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@67505 91177308-0d34-0410-b5e6-96231b3b80d8
2009-03-23VC++ 6.0 is not future work :)Chris Lattner
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
2009-01-02So *this* is where all the trailing whitespace in file header comments comeMisha Brukman
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
2008-12-11* <div align=center> is not valid HTML 4.01 - removed alignmentMisha Brukman
* <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
2008-12-11Global replace of yellow W3C "valid HTML/CSS" icons with blue ones.Misha Brukman
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60880 91177308-0d34-0410-b5e6-96231b3b80d8
2008-12-10s/A Few Coding Standards/LLVM Coding Standards/gMisha Brukman
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60859 91177308-0d34-0410-b5e6-96231b3b80d8
2008-11-29Fix spelling mistake.Nick Lewycky
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60250 91177308-0d34-0410-b5e6-96231b3b80d8
2008-11-24Fix a few HTML tidiness issues.Dan Gohman
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@59966 91177308-0d34-0410-b5e6-96231b3b80d8
2008-07-30Not that using stream headers other than iostream is allowed.Matthijs Kooijman
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@54209 91177308-0d34-0410-b5e6-96231b3b80d8
2008-07-08clarify :)Chris Lattner
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@53218 91177308-0d34-0410-b5e6-96231b3b80d8
generated by cgit v1.2.3-18-g5258 (git 2.32.0) at 2025-04-28 03:07:43 +0000