[llvm-commits] [llvm] r43766 - /llvm/trunk/docs/CodingStandards.html

[Bill Wendling]

Author: void
Date: Tue Nov  6 03:36:34 2007
New Revision: 43766

URL: http://llvm.org/viewvc/llvm-project?rev=43766&view=rev
Log:
Clarify some of the iostreams stuff.

Modified:
    llvm/trunk/docs/CodingStandards.html

Modified: llvm/trunk/docs/CodingStandards.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CodingStandards.html?rev=43766&r1=43765&r2=43766&view=diff

==============================================================================
--- llvm/trunk/docs/CodingStandards.html (original)
+++ llvm/trunk/docs/CodingStandards.html Tue Nov  6 03:36:34 2007
@@ -505,14 +505,14 @@
 
 <ol>
   <li>The time to run the static c'tors impacts startup time of
-      applications—a critical time for gui apps.</li>
+      applications—a critical time for GUI apps.</li>
   <li>The static c'tors cause the app to pull many extra pages of memory off the
-      disk: both the code for the static c'tors in each .o file and the small
-      amount of data that gets touched.  In addition, touched/dirty pages put
-      more pressure on the VM system on low-memory machines.</li>
+      disk: both the code for the static c'tors in each <tt>.o</tt> file and the
+      small amount of data that gets touched. In addition, touched/dirty pages
+      put more pressure on the VM system on low-memory machines.</li>
 </ol>
 
-<div style="align: center">
+<div align="center">
 <table>
   <tbody>
     <tr>
@@ -527,7 +527,7 @@
       <td align="left"><pre>DEBUG(std::cerr << ...);
 DEBUG(dump(std::cerr));</pre></td>
       <td align="left"><pre>DOUT << ...;
-dump(DOUT);</pre></td>
+DEBUG(dump(DOUT));</pre></td>
     </tr>
     <tr>
       <td align="left"><pre>std::cerr << "Hello world\n";</pre></td>
@@ -557,17 +557,17 @@
       <td align="left"><pre>void print(std::ostream &Out);
 // ...
 print(std::cerr);</pre></td>
-      <td align="left"><pre>void print(std::ostream &Out);
-void print(std::ostream *Out) { if (Out) print(*Out) }
+      <td align="left"><pre>void print(llvm::OStream Out);<sup>1</sup>
 // ...
 print(llvm::cerr);</pre>
 
+</td> </tbody> </table>
+</div>
+
 <div class="doc_text">
-<i>N.B.</i> The second <tt>print</tt> method is called by the <tt>print</tt>
-expression. It prevents the execution of the first <tt>print</tt> method if the
-stream is <tt>cnull</tt>.</div></td>
-   </tbody>
-</table>
+<p><sup>1</sup><tt>llvm::OStream</tt> is a light-weight class so it should never
+be passed by reference. This is important because in some configurations,
+<tt>DOUT</tt> is an rvalue.</p>
 </div>
 
 </div>