Commit 5ae881f9 authored by Jonas Devlieghere's avatar Jonas Devlieghere
Browse files

[Docs] Repurpose 'sources' page as 'contributing'. 

The page describing how to get the sources was more about contributing
to LLDB than getting the actual source. This patch moves some things
around and repurposes this page as a contributing to LLDB landing page.
parent 38839d08

lldb/docs/.htaccess

+3 −1
Original line number Diff line number Diff line
@@ -6,6 +6,8 @@ Redirect 301 /goals.html https://lldb.llvm.org/status/goals.html 
Redirect 301 /lldb-gdb.html https://lldb.llvm.org/use/map.html

Redirect 301 /projects.html https://lldb.llvm.org/status/projects.html

Redirect 301 /remote.html https://lldb.llvm.org/use/remote.html

Redirect 301 /source.html https://lldb.llvm.org/resources/source.html

Redirect 301 /source.html https://lldb.llvm.org/resources/contributing.html

Redirect 301 /tutorial.html https://lldb.llvm.org/use/tutorial.html

Redirect 301 /varformats.html https://lldb.llvm.org/use/variable.html



Redirect 301 /resources/source.html https://lldb.llvm.org/resources/contributing.html

lldb/docs/index.rst

+2 −2
Original line number Diff line number Diff line
@@ -138,12 +138,12 @@ interesting areas to contribute to lldb. 
   :maxdepth: 1

   :caption: Resources



   resources/download

   resources/source

   resources/contributing

   resources/build

   resources/test

   resources/bots

   resources/sbapi

   resources/download



.. toctree::

   :hidden:

lldb/docs/resources/build.rst

+12 −2
Original line number Diff line number Diff line 
Build

=====

Building

========



.. contents::

   :local:



Getting the Sources

-------------------



Please refer to the `LLVM Getting Started Guide

<https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm>`_ for

general instructions on how to check out the LLVM monorepo, which contains the

LLDB sources.



Git browser: https://github.com/llvm/llvm-project/tree/master/lldb



Preliminaries

-------------

lldb/docs/resources/source.rst→lldb/docs/resources/contributing.rst

+19 −16
Original line number Diff line number Diff line 
Getting the Sources

===================

Contributing

============



Refer to the `LLVM Getting Started Guide

<https://llvm.org/docs/GettingStarted.html#getting-started-with-llvm>`_

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 and build as described at the above URL. The same

repository also contains LLDB.

Getting Started

---------------



Git browser: https://github.com/llvm/llvm-project/tree/master/lldb



Refer to the `Build Instructions <build.html>`_ for more detailed instructions

on how to build for a particular platform / build system combination.

Please refer to the `LLVM Getting Started Guide

<https://llvm.org/docs/GettingStarted.html>`_ for general information on how to

get started on the LLVM project. A detailed explanation on how to build and

test LLDB can be found in the `build instructions <build.html>`_ and `test

instructions <test.html>`_ respecitvely.



Contributing to LLDB

--------------------
@@ -21,10 +18,16 @@ Please refer to the `LLVM Developer Policy 
authoring and uploading a patch. LLDB differs from the LLVM Developer

Policy in the following respects.



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.  For

anything not explicitly listed here, assume that LLDB follows the LLVM

 - **Test infrastructure**: Like LLVM it is  important to submit tests with your

   patches, but note that LLDB uses a different system for tests. Refer to the

   `test documentation <test.html>`_ for more details and the `lldb/test`

   folder on disk for examples.



 - **Coding Style**: LLDB's code style differs from LLVM's coding style.

   Unfortunately there is no document describing the different. Please be

   consistent with the existing code.



For anything not explicitly listed here, assume that LLDB follows the LLVM

policy.