Daniel Dunbar
adea497673
[docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155153 91177308-0d34-0410-b5e6-96231b3b80d8
2012-04-19 20:20:34 +00:00
NAKAMURA Takumi
9c55f5965b
llvm/docs/*.html: Fix markups.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@153508 91177308-0d34-0410-b5e6-96231b3b80d8
2012-03-27 11:25:16 +00:00
Chris Lattner
748c1ec713
clarify the coding standards a bit.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@152957 91177308-0d34-0410-b5e6-96231b3b80d8
2012-03-16 22:34:37 +00:00
Chris Lattner
9b6e59d903
add an explicit section on static constructors.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@150037 91177308-0d34-0410-b5e6-96231b3b80d8
2012-02-08 01:44:00 +00:00
NAKAMURA Takumi
5c6e4df713
docs/*.html: Appease W3C Checker to add "charset=utf-8".
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@143348 91177308-0d34-0410-b5e6-96231b3b80d8
2011-10-31 11:21:59 +00:00
Chris Lattner
c513309224
apparently variable naming conventions never got added, document the
...
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-08-12 19:49:16 +00:00
NAKAMURA Takumi
f5af6ada3b
docs: Introduce cascading style <div> and <p> continued on <h[2-5]>.
...
<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-23 00:30:22 +00:00
NAKAMURA Takumi
05d0265fef
docs: Use <Hn> as Heading elements instead of <DIV class="doc_foo">.
...
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-18 23:59:50 +00:00
NAKAMURA Takumi
b9a33634cc
docs: Canonicalize URLs.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129181 91177308-0d34-0410-b5e6-96231b3b80d8
2011-04-09 02:13:37 +00:00
Nick Lewycky
7ac0199287
Fix typo.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@126065 91177308-0d34-0410-b5e6-96231b3b80d8
2011-02-20 02:03:04 +00:00
Bill Wendling
b8602039f1
Grammar corrections and some formatting changes.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@122312 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-21 03:31:05 +00:00
Chris Lattner
78ceb3a415
fix some validation problems
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121444 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-10 00:54:03 +00:00
Chris Lattner
69ad797214
restructure this for readability, correct the example to follow the public ivar name convention
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121443 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-10 00:52:35 +00:00
Chris Lattner
98bec51b35
add a rule for enums, patch by Zhanyong Wan!
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@121430 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-09 23:32:39 +00:00
Zhanyong Wan
7fcd4dcb98
Add naming rules to the coding standards.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@120689 91177308-0d34-0410-b5e6-96231b3b80d8
2010-12-02 05:10:07 +00:00
Chris Lattner
558f5d2a39
forbid rtti and exceptions
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@120450 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-30 19:20:40 +00:00
Zhanyong Wan
cafe0b4e1f
Fix formatting nits in the coding standards. Reviewed by clattner.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119998 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-23 05:03:07 +00:00
Chris Lattner
eddd96901e
add some justification for "using namespace llvm;"
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119544 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-17 19:47:20 +00:00
Chris Lattner
684cf814c7
various cleanups and other improvements, patch by Zhanyong Wan!
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@119515 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-17 17:14:55 +00:00
Chris Lattner
221b239342
update coding standards. Partial specialization is now ok,
...
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-16 22:19:06 +00:00
Chris Lattner
97928d136a
describe the preferred approach to silencing 'unused variable warnings' due to asserts.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@118863 91177308-0d34-0410-b5e6-96231b3b80d8
2010-11-12 00:19:41 +00:00
Duncan Sands
18d52f2fb5
Convert a bunch of uses of 'bytecode' into 'bitcode'. This
...
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-09-29 20:09:55 +00:00
mike-m
e2c3a49c80
Revert r103213. It broke several sections of live website.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103219 91177308-0d34-0410-b5e6-96231b3b80d8
2010-05-07 00:28:04 +00:00
mike-m
68cb31901c
Overhauled llvm/clang docs builds. Closes PR6613.
...
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-05-06 23:45:43 +00:00
Dan Gohman
621a415c01
Fix typos in comments.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@97257 91177308-0d34-0410-b5e6-96231b3b80d8
2010-02-26 20:18:32 +00:00
Benjamin Kramer
8040cd3cfd
Documentation: Perform automated correction of common typos.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@83849 91177308-0d34-0410-b5e6-96231b3b80d8
2009-10-12 14:46:08 +00:00
Chris Lattner
983c592272
disuade people from using ostream.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79866 91177308-0d34-0410-b5e6-96231b3b80d8
2009-08-23 21:53:47 +00:00
Chris Lattner
5731020b2f
make owen happy by being explicit.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@78688 91177308-0d34-0410-b5e6-96231b3b80d8
2009-08-11 17:38:15 +00:00
Chris Lattner
9eb7e0aa57
discourage else after "noreturn" statements.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77387 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-28 22:54:04 +00:00
Daniel Dunbar
26fe866cec
Tweak, raw_ostream is a ostream, not iostream replacement
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77017 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-24 23:54:34 +00:00
Daniel Dunbar
e8530a3d8c
CodingStandards: Emphasize use of raw_ostream more.
...
- Chris, please approve.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77010 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-24 23:04:51 +00:00
Chris Lattner
59fec6a532
fix some wording problems Daniel pointed out, make a example actually real.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76751 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-22 16:54:14 +00:00
Chris Lattner
71d8f3b9e4
fix typo noticed by Duncan
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@76747 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-22 16:30:39 +00:00
Chris Lattner
219bd29c05
remove Bill from the author list: his contribution (describing llvm::Ostream
...
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-22 05:43:01 +00:00
Chris Lattner
d283cb12f2
add some more topics to the coding standards doc:
...
* 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-22 05:40:54 +00:00
Chris Lattner
b927ca813b
be explicit about making comments real sentences.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75406 91177308-0d34-0410-b5e6-96231b3b80d8
2009-07-12 00:10:24 +00:00
Chris Lattner
a44f87f2e7
got confused again
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74514 91177308-0d34-0410-b5e6-96231b3b80d8
2009-06-30 06:27:54 +00:00
Chris Lattner
09bc65e62b
fix some issues Jeff Yasskin noticed
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74512 91177308-0d34-0410-b5e6-96231b3b80d8
2009-06-30 06:20:03 +00:00
Chris Lattner
0af39ea9ef
add a note about re-evaluating end() every time through a loop.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@74511 91177308-0d34-0410-b5e6-96231b3b80d8
2009-06-30 06:13:23 +00:00
Chris Lattner
640e7c6d07
tt'ify.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@67505 91177308-0d34-0410-b5e6-96231b3b80d8
2009-03-23 04:53:34 +00:00
Chris Lattner
4bd3d7e17c
VC++ 6.0 is not future work :)
...
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-03-23 04:52:53 +00:00
Misha Brukman
98117cdbd6
So *this* is where all the trailing whitespace in file header comments come
...
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
2009-01-02 16:58:42 +00:00
Misha Brukman
2d33c5443a
* <div align=center> is not valid HTML 4.01 - removed alignment
...
* <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-11 19:37:04 +00:00
Misha Brukman
444087057a
Global replace of yellow W3C "valid HTML/CSS" icons with blue ones.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60880 91177308-0d34-0410-b5e6-96231b3b80d8
2008-12-11 17:34:48 +00:00
Misha Brukman
c1449e63ff
s/A Few Coding Standards/LLVM Coding Standards/g
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60859 91177308-0d34-0410-b5e6-96231b3b80d8
2008-12-10 23:07:02 +00:00
Nick Lewycky
822293a40c
Fix spelling mistake.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60250 91177308-0d34-0410-b5e6-96231b3b80d8
2008-11-29 20:13:25 +00:00
Dan Gohman
f003276ee6
Fix a few HTML tidiness issues.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@59966 91177308-0d34-0410-b5e6-96231b3b80d8
2008-11-24 17:18:39 +00:00
Matthijs Kooijman
ed58a97afd
Not that using stream headers other than iostream is allowed.
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@54209 91177308-0d34-0410-b5e6-96231b3b80d8
2008-07-30 12:14:10 +00:00
Chris Lattner
5822e9e57f
clarify :)
...
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@53218 91177308-0d34-0410-b5e6-96231b3b80d8
2008-07-08 05:12:37 +00:00
Nick Lewycky
f4408e8c3e
Add a standard for control-flow unreachable assertions in functions that return
...
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
2008-05-31 23:54:55 +00:00