Commit Graph

66 Commits

Author SHA1 Message Date
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
Chris Lattner
ab2b10c3a9 Don't attribute in file headers anymore. See llvmdev for the
discussion of this change.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45409 91177308-0d34-0410-b5e6-96231b3b80d8
2007-12-29 19:56:08 +00:00
Chris Lattner
788ee28a3e Update links.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@43964 91177308-0d34-0410-b5e6-96231b3b80d8
2007-11-09 21:49:08 +00:00
Bill Wendling
4f6766d41e Clarify some of the iostreams stuff.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@43766 91177308-0d34-0410-b5e6-96231b3b80d8
2007-11-06 09:36:34 +00:00
Bill Wendling
96802d1602 Validation fixes
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@42229 91177308-0d34-0410-b5e6-96231b3b80d8
2007-09-22 10:03:25 +00:00
Reid Spencer
669ed45029 Subversionify the documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@38442 91177308-0d34-0410-b5e6-96231b3b80d8
2007-07-09 08:04:31 +00:00
Chris Lattner
4f28a2f88f clarify the 'developed by' line
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@34400 91177308-0d34-0410-b5e6-96231b3b80d8
2007-02-19 03:33:06 +00:00
Chris Lattner
5da59b1fe2 fix a grammar ambiguity noticed by Duncan
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@34151 91177308-0d34-0410-b5e6-96231b3b80d8
2007-02-10 18:35:31 +00:00
Bill Wendling
10e7c42157 Removed reference to "cnull" because typical users shouldn't need to use
it.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@32869 91177308-0d34-0410-b5e6-96231b3b80d8
2007-01-04 08:38:04 +00:00
Bill Wendling
b0a9d1b9bc Added example of how to code print() methods so that they will disappear
from the code if "cnull" is passed into them.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@32641 91177308-0d34-0410-b5e6-96231b3b80d8
2006-12-17 11:40:40 +00:00
Bill Wendling
4ad6d61cb7 Fixed some formatting.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@32392 91177308-0d34-0410-b5e6-96231b3b80d8
2006-12-09 01:35:43 +00:00
Bill Wendling
0f7c10d7b6 Another example of using the llvm IO streams.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@32391 91177308-0d34-0410-b5e6-96231b3b80d8
2006-12-09 01:27:51 +00:00
Bill Wendling
7f564c02cf Add documentation for how to use the new LLVM streams.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@32390 91177308-0d34-0410-b5e6-96231b3b80d8
2006-12-09 01:20:34 +00:00
Jim Laskey
f55914a529 Fix a couple typos.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29416 91177308-0d34-0410-b5e6-96231b3b80d8
2006-07-31 20:18:49 +00:00
Chris Lattner
6883a88fdb Add some advice
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29324 91177308-0d34-0410-b5e6-96231b3b80d8
2006-07-27 04:24:14 +00:00
Reid Spencer
05fe4b0256 Changes docs for llvm.cs.uiuc.edu -> llvm.org
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@26746 91177308-0d34-0410-b5e6-96231b3b80d8
2006-03-14 05:39:39 +00:00
Chris Lattner
b0bff9eefe Add a section about using namespaces.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@25054 91177308-0d34-0410-b5e6-96231b3b80d8
2006-01-01 21:59:22 +00:00
Misha Brukman
3b53a26191 Documentation which contains smileys won't be taken seriously by some people.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18474 91177308-0d34-0410-b5e6-96231b3b80d8
2004-12-04 00:32:12 +00:00
Misha Brukman
91d64afebd Use <tt> around "#include" and "std::endl"
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17258 91177308-0d34-0410-b5e6-96231b3b80d8
2004-10-26 16:18:43 +00:00
Misha Brukman
84d17fea63 Use <tt> around header names
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17256 91177308-0d34-0410-b5e6-96231b3b80d8
2004-10-26 16:07:46 +00:00
Misha Brukman
edcc78aefc * Fix spelling and grammar errors
* Close <p> tags properly
* Break up paragraphs with blank lines, clean up text alignment
* Delete unbalanced "


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17254 91177308-0d34-0410-b5e6-96231b3b80d8
2004-10-26 15:45:13 +00:00
Reid Spencer
b40df56f26 Add a blurb about the use of class vs. struct keyword in class decls.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@16500 91177308-0d34-0410-b5e6-96231b3b80d8
2004-09-23 16:03:48 +00:00
Misha Brukman
69c5889d60 Fix grammar, eliminate double parenthesized sentence fragment.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15313 91177308-0d34-0410-b5e6-96231b3b80d8
2004-07-28 22:37:57 +00:00
Misha Brukman
a8c760a770 * Wrap code listings in <div class="doc_code">
* Wrap keywords in <tt>
* Wrap lines at 80 cols


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15312 91177308-0d34-0410-b5e6-96231b3b80d8
2004-07-28 22:31:54 +00:00
Tanya Lattner
09cf73c830 Fixed broken links.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14313 91177308-0d34-0410-b5e6-96231b3b80d8
2004-06-22 04:24:55 +00:00
Misha Brukman
179bf4bf39 Fix broken internal link.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14002 91177308-0d34-0410-b5e6-96231b3b80d8
2004-06-03 23:42:24 +00:00