[Lldb-commits] [lldb] 5ae881f - [Docs] Repurpose 'sources' page as 'contributing'.

[Jonas Devlieghere via lldb-commits]

Author: Jonas Devlieghere
Date: 2019-10-28T15:03:05-07:00
New Revision: 5ae881f96f999aaca98d8f83d3f00e037c783647

URL: https://github.com/llvm/llvm-project/commit/5ae881f96f999aaca98d8f83d3f00e037c783647
DIFF: https://github.com/llvm/llvm-project/commit/5ae881f96f999aaca98d8f83d3f00e037c783647.diff

LOG: [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.

Added: 
    lldb/docs/resources/contributing.rst

Modified: 
    lldb/docs/.htaccess
    lldb/docs/index.rst
    lldb/docs/resources/build.rst

Removed: 
    lldb/docs/resources/source.rst


################################################################################
diff  --git a/lldb/docs/.htaccess b/lldb/docs/.htaccess
index aa63b1e0468f..cc92b0a65cfa 100644
--- a/lldb/docs/.htaccess
+++ b/lldb/docs/.htaccess
@@ -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

diff  --git a/lldb/docs/index.rst b/lldb/docs/index.rst
index faabed9c691a..b833821554b1 100644
--- a/lldb/docs/index.rst
+++ b/lldb/docs/index.rst
@@ -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:

diff  --git a/lldb/docs/resources/build.rst b/lldb/docs/resources/build.rst
index ec938f41e21c..dabd224feff5 100644
--- a/lldb/docs/resources/build.rst
+++ b/lldb/docs/resources/build.rst
@@ -1,9 +1,19 @@
-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
 -------------
 

diff  --git a/lldb/docs/resources/source.rst b/lldb/docs/resources/contributing.rst
similarity index 77%
rename from lldb/docs/resources/source.rst
rename to lldb/docs/resources/contributing.rst
index 0216d30d5c06..4305cdcaaf44 100644
--- a/lldb/docs/resources/source.rst
+++ b/lldb/docs/resources/contributing.rst
@@ -1,17 +1,14 @@
-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 
diff ers 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 
diff erent 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 
diff erent 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 
diff ers from LLVM's coding style.
+   Unfortunately there is no document describing the 
diff erent. Please be
+   consistent with the existing code.
+
+For anything not explicitly listed here, assume that LLDB follows the LLVM
 policy.