diff options
| author | Zachary Turner <zturner@google.com> | 2015-03-10 23:22:25 +0000 |
|---|---|---|
| committer | Zachary Turner <zturner@google.com> | 2015-03-10 23:22:25 +0000 |
| commit | c99b5ce13ac101a3a0773d8f8ef72642e6303e88 (patch) | |
| tree | d2815fe9f75b767d5ec62a9b77a67bf465923c2b /lldb/www/source.html | |
| parent | 49338e9fa6f823b20787201a11f6b2f81aecfc4e (diff) | |
| download | bcm5719-llvm-c99b5ce13ac101a3a0773d8f8ef72642e6303e88.tar.gz bcm5719-llvm-c99b5ce13ac101a3a0773d8f8ef72642e6303e88.zip | |
Update build instructions / coding conventions.
This improves the instructions for checking out LLDB, adds
more links to LLVM instructions, and more explicitly calls out
when we differ from the style guide.
Also updates the clang-format configuration file to correctly
reflect a 120 column limit.
Reviewed by: Jim Ingham
Differential Revision: http://reviews.llvm.org/D8222
llvm-svn: 231884
Diffstat (limited to 'lldb/www/source.html')
| -rwxr-xr-x | lldb/www/source.html | 76 |
1 files changed, 56 insertions, 20 deletions
diff --git a/lldb/www/source.html b/lldb/www/source.html index 2138cd43b51..a92fdb5856a 100755 --- a/lldb/www/source.html +++ b/lldb/www/source.html @@ -18,30 +18,66 @@ <div id="middle"> <div class="post"> - <h1 class ="postheader">Downloading LLDB sources</h1> - <div class="postcontent"> - <p>Obtaining read only access to the LLDB sources is easy:</p> - <ul> - <li>svn co http://llvm.org/svn/llvm-project/lldb/trunk lldb</li> - </ul> - <p>If you prefer using Git, you can check out LLDB from the <a href="http://llvm.org/docs/GettingStarted.html#git-mirror">LLVM git mirror</a> instead:</p> - <ul> - <li>git clone http://llvm.org/git/lldb.git</li> - </ul> - </div> - <div class="postfooter"></div> + <h1 class ="postheader">Checking out LLDB sources</h1> + <div class="postcontent"> + <p>Refer to the <a href="http://llvm.org/docs/GettingStarted.html#getting-started-with-llvm">LLVM Getting Started Guide</a> + for general instructions on how to check out source. Note that LLDB depends on having a working checkout of LLVM + and Clang, so the first step is to download LLVM and Clang sources as described at the above URL. Then you can + additionally download the LLDB sources from the following repository URLs.</p> + <p><b>SVN Repository</b>: http://llvm.org/svn/llvm-project/lldb/trunk </p> + <p><b>Git Clone</b>: http://llvm.org/git/lldb.git </p> + <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>
+ </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> + </div> </div> <div class="post"> <h1 class ="postheader">Contributing to LLDB</h1> <div class="postcontent"> - <p>If you wish to contribute to LLDB, you must first get commit access by - <a href="http://llvm.org/docs/DeveloperPolicy.html#obtaining-commit-access">requesting commit access</a></p> - <p>Once you have commit access, you will have a <b>USERNAME</b> and you can checkout the sources: - <a href="http://llvm.org/docs/DeveloperPolicy.html#obtaining-commit-access">requesting commit access</a></p> - <ul> - <li>svn co https://USERNAME@llvm.org/svn/llvm-project/lldb/trunk lldb</li> - </ul> - </div> + <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> </div> </div> |
