Commit Graph

65 Commits

Author SHA1 Message Date
Chris Lattner
5db2ff5037 disuade people from using ostream.
llvm-svn: 79866
2009-08-23 21:53:47 +00:00
Chris Lattner
73e9f8c636 make owen happy by being explicit.
llvm-svn: 78688
2009-08-11 17:38:15 +00:00
Chris Lattner
14abb832b2 discourage else after "noreturn" statements.
llvm-svn: 77387
2009-07-28 22:54:04 +00:00
Daniel Dunbar
4bd53c6479 Tweak, raw_ostream is a ostream, not iostream replacement
llvm-svn: 77017
2009-07-24 23:54:34 +00:00
Daniel Dunbar
fcd54f73bf CodingStandards: Emphasize use of raw_ostream more.
- Chris, please approve.

llvm-svn: 77010
2009-07-24 23:04:51 +00:00
Chris Lattner
d63f12373d fix some wording problems Daniel pointed out, make a example actually real.
llvm-svn: 76751
2009-07-22 16:54:14 +00:00
Chris Lattner
611a1883e5 fix typo noticed by Duncan
llvm-svn: 76747
2009-07-22 16:30:39 +00:00
Chris Lattner
9567fffc36 remove Bill from the author list: his contribution (describing llvm::Ostream
and friends) has been removed awhile ago.

llvm-svn: 76724
2009-07-22 05:43:01 +00:00
Chris Lattner
6720d7edda 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

llvm-svn: 76723
2009-07-22 05:40:54 +00:00
Chris Lattner
bbe228ba10 be explicit about making comments real sentences.
llvm-svn: 75406
2009-07-12 00:10:24 +00:00
Chris Lattner
67f2a4ac4e got confused again
llvm-svn: 74514
2009-06-30 06:27:54 +00:00
Chris Lattner
6ad089cc54 fix some issues Jeff Yasskin noticed
llvm-svn: 74512
2009-06-30 06:20:03 +00:00
Chris Lattner
56c1094999 add a note about re-evaluating end() every time through a loop.
llvm-svn: 74511
2009-06-30 06:13:23 +00:00
Chris Lattner
57be315d36 tt'ify.
llvm-svn: 67505
2009-03-23 04:53:34 +00:00
Chris Lattner
30bc972596 VC++ 6.0 is not future work :)
Do not recommend llvm::OStream anymore.  Use raw_ostream or MemoryBuffer.

llvm-svn: 67504
2009-03-23 04:52:53 +00:00
Misha Brukman
02805a6423 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.

llvm-svn: 61586
2009-01-02 16:58:42 +00:00
Misha Brukman
586a15c995 * <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

llvm-svn: 60889
2008-12-11 19:37:04 +00:00
Misha Brukman
86242e1990 Global replace of yellow W3C "valid HTML/CSS" icons with blue ones.
llvm-svn: 60880
2008-12-11 17:34:48 +00:00
Misha Brukman
6c2522a1cf s/A Few Coding Standards/LLVM Coding Standards/g
llvm-svn: 60859
2008-12-10 23:07:02 +00:00
Nick Lewycky
35847809b7 Fix spelling mistake.
llvm-svn: 60250
2008-11-29 20:13:25 +00:00
Dan Gohman
8ef449828f Fix a few HTML tidiness issues.
llvm-svn: 59966
2008-11-24 17:18:39 +00:00
Matthijs Kooijman
ca4ffaabcd Not that using stream headers other than iostream is allowed.
llvm-svn: 54209
2008-07-30 12:14:10 +00:00
Chris Lattner
fc12d2e5f3 clarify :)
llvm-svn: 53218
2008-07-08 05:12:37 +00:00
Nick Lewycky
fb75d42faa Add a standard for control-flow unreachable assertions in functions that return
values, so as to avoid warnings on some platforms.

llvm-svn: 51831
2008-05-31 23:54:55 +00:00
Chris Lattner
ebf5666abf Don't attribute in file headers anymore. See llvmdev for the
discussion of this change.

llvm-svn: 45409
2007-12-29 19:56:08 +00:00
Chris Lattner
f9f08bf4b0 Update links.
llvm-svn: 43964
2007-11-09 21:49:08 +00:00
Bill Wendling
56235a28ce Clarify some of the iostreams stuff.
llvm-svn: 43766
2007-11-06 09:36:34 +00:00
Bill Wendling
bdd6bd8236 Validation fixes
llvm-svn: 42229
2007-09-22 10:03:25 +00:00
Reid Spencer
c7f87f202e Subversionify the documentation.
llvm-svn: 38442
2007-07-09 08:04:31 +00:00
Chris Lattner
8503007331 clarify the 'developed by' line
llvm-svn: 34400
2007-02-19 03:33:06 +00:00
Chris Lattner
756f83fdf9 fix a grammar ambiguity noticed by Duncan
llvm-svn: 34151
2007-02-10 18:35:31 +00:00
Bill Wendling
4d95e91eca Removed reference to "cnull" because typical users shouldn't need to use
it.

llvm-svn: 32869
2007-01-04 08:38:04 +00:00
Bill Wendling
3307244ce9 Added example of how to code print() methods so that they will disappear
from the code if "cnull" is passed into them.

llvm-svn: 32641
2006-12-17 11:40:40 +00:00
Bill Wendling
b0629487d8 Fixed some formatting.
llvm-svn: 32392
2006-12-09 01:35:43 +00:00
Bill Wendling
c78ae26ff8 Another example of using the llvm IO streams.
llvm-svn: 32391
2006-12-09 01:27:51 +00:00
Bill Wendling
2b52dc1753 Add documentation for how to use the new LLVM streams.
llvm-svn: 32390
2006-12-09 01:20:34 +00:00
Jim Laskey
88b5e790b5 Fix a couple typos.
llvm-svn: 29416
2006-07-31 20:18:49 +00:00
Chris Lattner
85ea83e821 Add some advice
llvm-svn: 29324
2006-07-27 04:24:14 +00:00
Reid Spencer
ca05854a71 Changes docs for llvm.cs.uiuc.edu -> llvm.org
llvm-svn: 26746
2006-03-14 05:39:39 +00:00
Chris Lattner
01e81e60ed Add a section about using namespaces.
llvm-svn: 25054
2006-01-01 21:59:22 +00:00
Misha Brukman
6d1686c18b Documentation which contains smileys won't be taken seriously by some people.
llvm-svn: 18474
2004-12-04 00:32:12 +00:00
Misha Brukman
03f87d527d Use <tt> around "#include" and "std::endl"
llvm-svn: 17258
2004-10-26 16:18:43 +00:00
Misha Brukman
d73c8428f1 Use <tt> around header names
llvm-svn: 17256
2004-10-26 16:07:46 +00:00
Misha Brukman
f2499137d7 * Fix spelling and grammar errors
* Close <p> tags properly
* Break up paragraphs with blank lines, clean up text alignment
* Delete unbalanced "

llvm-svn: 17254
2004-10-26 15:45:13 +00:00
Reid Spencer
bf6439fd27 Add a blurb about the use of class vs. struct keyword in class decls.
llvm-svn: 16500
2004-09-23 16:03:48 +00:00
Misha Brukman
0d640e87d1 Fix grammar, eliminate double parenthesized sentence fragment.
llvm-svn: 15313
2004-07-28 22:37:57 +00:00
Misha Brukman
b2246154df * Wrap code listings in <div class="doc_code">
* Wrap keywords in <tt>
* Wrap lines at 80 cols

llvm-svn: 15312
2004-07-28 22:31:54 +00:00
Tanya Lattner
8ed32be935 Fixed broken links.
llvm-svn: 14313
2004-06-22 04:24:55 +00:00
Misha Brukman
3155159ef9 Fix broken internal link.
llvm-svn: 14002
2004-06-03 23:42:24 +00:00
Chris Lattner
1dab192f22 Update the coding standards, removign the bit about avoiding exceptions and
rtti (they shouldn't be used in the main compiler, but that's because
optimizations aren't allowed to fail!)

Remove the big section about iterators, because people who do not know what
they are doing shouldn't be writing them.  :)

llvm-svn: 13670
2004-05-23 21:05:07 +00:00