diff options
author | Daniel Dunbar <daniel@zuster.org> | 2010-01-22 02:04:46 +0000 |
---|---|---|
committer | Daniel Dunbar <daniel@zuster.org> | 2010-01-22 02:04:46 +0000 |
commit | 79bba50f349fa891d87bc0b7fd24aea9a19bd227 (patch) | |
tree | fd0dcc0c260f9b30c28d350c7e47909709e4a2a3 /www/hacking.html | |
parent | f3f91f3719a95036175ad767805657cdfeb54406 (diff) |
Add a Coding Standards section to hacking.html, and point out that cstdio is forbidden.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@94137 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'www/hacking.html')
-rw-r--r-- | www/hacking.html | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/www/hacking.html b/www/hacking.html index ec9cd97cba..3bbc0eaea8 100644 --- a/www/hacking.html +++ b/www/hacking.html @@ -19,6 +19,7 @@ on Clang for developers who are new to the Clang and/or LLVM codebases.</p> <ul> + <li><a href="#style">Coding Standards</a></li> <li><a href="#docs">Developer Documentation</a></li> <li><a href="#debugging">Debugging</a></li> <li><a href="#testing">Testing</a></li> @@ -31,6 +32,27 @@ </ul> <!--=====================================================================--> + <h2 id="docs">Coding Standards</h2> + <!--=====================================================================--> + + <p>Clang follows the + LLVM <a href="http://llvm.org/docs/CodingStandards.html">Coding + Standards</a>. When submitting patches, please take care to follow these standards + and to match the style of the code to that present in Clang (for example, in + terms of indentation, bracing, and statement spacing).</p> + + <p>Clang has a few additional coding standards:</p> + <ul> + <li><i>cstdio is forbidden</i>: library code should not output diagnostics + or other information using <tt>cstdio</tt>; debugging routines should + use <tt>llvm::errs()</tt>. Other uses of <tt>cstdio</tt> impose behavior + upon clients and block integrating Clang as a library. Libraries should + support <tt>raw_ostream</tt> based interfaces for textual + output. See <a href="http://llvm.org/docs/CodingStandards.html#ll_raw_ostream">Coding + Standards</a>.</li> + </ul> + + <!--=====================================================================--> <h2 id="docs">Developer Documentation</h2> <!--=====================================================================--> |