diff options
Diffstat (limited to 'lldb/www')
| -rw-r--r-- | lldb/www/lldb-coding-conventions.html | 28 | ||||
| -rwxr-xr-x | lldb/www/source.html | 80 |
2 files changed, 54 insertions, 54 deletions
diff --git a/lldb/www/lldb-coding-conventions.html b/lldb/www/lldb-coding-conventions.html index 7cd959ccf9d..c3702decb31 100644 --- a/lldb/www/lldb-coding-conventions.html +++ b/lldb/www/lldb-coding-conventions.html @@ -22,20 +22,20 @@ <p>The LLDB coding conventions differ in a few important respects from LLVM.</p> - <p>
- Note that <a href="http://clang.llvm.org/docs/ClangFormat.html">clang-format</a> will deal with
- most of this for you, as such is suggested to run on patches before uploading. Note however that
- clang-format is not smart enough to detect instances of humans intentionally trying to line variables
- up on a particular column boundary, and it will reformat them to remove this "extraneous" whitespace.
- While this is usually the correct behavior, LLDB does have many uses of manually aligned types and
- fields, so please be aware of this behavior of clang-format when editing this type of code.
- </p>
- <p>
- <b>Important</b>: Where not explicitly outlined below, assume that the
- <a href="http://llvm.org/docs/CodingStandards.html">LLVM Coding Conventions</a> are to be followed.
- </p>
-
- <h3>Source code width:</h3>
+ <p> + Note that <a href="http://clang.llvm.org/docs/ClangFormat.html">clang-format</a> will deal with + most of this for you, as such is suggested to run on patches before uploading. Note however that + clang-format is not smart enough to detect instances of humans intentionally trying to line variables + up on a particular column boundary, and it will reformat them to remove this "extraneous" whitespace. + While this is usually the correct behavior, LLDB does have many uses of manually aligned types and + fields, so please be aware of this behavior of clang-format when editing this type of code. + </p> + <p> + <b>Important</b>: Where not explicitly outlined below, assume that the + <a href="http://llvm.org/docs/CodingStandards.html">LLVM Coding Conventions</a> are to be followed. + </p> + + <h3>Source code width:</h3> <p>lldb does not follow the 80 character line restriction llvm imposes. In our experience, trying to fit C++ code into an 80 character line results in code that is awkward to read, and the time spent trying to find good indentation points to diff --git a/lldb/www/source.html b/lldb/www/source.html index a92fdb5856a..86a3bda10a7 100755 --- a/lldb/www/source.html +++ b/lldb/www/source.html @@ -29,53 +29,53 @@ <p> For non-Mac platforms, and for MacOSX building with CMake (not Xcode), you should check out your sources to adhere to the following directory structure: - <pre><tt>
- llvm
- |
- `-- tools
- |
- +-- clang
- |
- `-- lldb
- </tt></pre>
+ <pre><tt> + llvm + | + `-- tools + | + +-- clang + | + `-- lldb + </tt></pre> </p> - <p>
- For MacOSX building from Xcode, simply checkout LLDB and then build from Xcode. The Xcode project will
- automatically detect that it is a fresh checkout, and checkout LLVM and clang automatically. Unlike other
- platforms / build systems, it will use the following directory structure.
- <pre><tt>
- lldb
- |
- `-- llvm
- |
- +-- tools
- |
- `-- clang
- </tt>
- </pre>
- So updating your checkout will consist of updating lldb, llvm, and clang in these locations.
- </p>
- <p>
- Refer to the <a href="build.html">Build Instructions</a> for more detailed instructions on how to build for a particular
- platform / build system combination.
+ <p> + For MacOSX building from Xcode, simply checkout LLDB and then build from Xcode. The Xcode project will + automatically detect that it is a fresh checkout, and checkout LLVM and clang automatically. Unlike other + platforms / build systems, it will use the following directory structure. + <pre><tt> + lldb + | + `-- llvm + | + +-- tools + | + `-- clang + </tt> + </pre> + So updating your checkout will consist of updating lldb, llvm, and clang in these locations. + </p> + <p> + Refer to the <a href="build.html">Build Instructions</a> for more detailed instructions on how to build for a particular + platform / build system combination. </p> </div> </div> <div class="post"> <h1 class ="postheader">Contributing to LLDB</h1> <div class="postcontent"> - <p>
- Please refer to the <a href="http://llvm.org/docs/DeveloperPolicy.html">LLVM Developer Policy</a>
- for information about authoring and uploading a patch. LLDB differs from the LLVM Developer Policy in
- the following respects.
- <ul>
- <li>Coding conventions. Refer to <a href="lldb-coding-conventions.html">LLDB Coding Conventions</a>.</li>
- <li>
- Test infrastructure. It is still important to submit tests with your patches, but LLDB uses a different
- system for tests. Refer to the lldb/test folder on disk for examples of how to write tests.
- </li>
- </ul>
- For anything not explicitly listed here, assume that LLDB follows the LLVM policy.
+ <p> + Please refer to the <a href="http://llvm.org/docs/DeveloperPolicy.html">LLVM Developer Policy</a> + for information about authoring and uploading a patch. LLDB differs from the LLVM Developer Policy in + the following respects. + <ul> + <li>Coding conventions. Refer to <a href="lldb-coding-conventions.html">LLDB Coding Conventions</a>.</li> + <li> + Test infrastructure. It is still important to submit tests with your patches, but LLDB uses a different + system for tests. Refer to the lldb/test folder on disk for examples of how to write tests. + </li> + </ul> + For anything not explicitly listed here, assume that LLDB follows the LLVM policy. </p> </div> <div class="postfooter"></div> |
