[Lldb-commits] [lldb] 128e999 - [lldb] Add a "design" section to the documentation.

[Jonas Devlieghere via lldb-commits]

Author: Jonas Devlieghere
Date: 2020-10-02T13:07:31-07:00
New Revision: 128e999d63c41e54d5d73c8af47e1ce401e6a200

URL: https://github.com/llvm/llvm-project/commit/128e999d63c41e54d5d73c8af47e1ce401e6a200
DIFF: https://github.com/llvm/llvm-project/commit/128e999d63c41e54d5d73c8af47e1ce401e6a200.diff

LOG: [lldb] Add a "design" section to the documentation.

Create a "Design" section for the LLDB documentation. The goal is to
have design documents that describe how the LLDB internals work.

Currently similar pages  are mixed together under the "Development". The
existing pages describing the architecture, the reproducers, the
structured data plugins, and the SB API could be housed here. I hope
we'd see more pages being added here in the future.

Differential revision: https://reviews.llvm.org/D88516

Added: 
    lldb/docs/design/overview.rst
    lldb/docs/design/reproducers.rst
    lldb/docs/design/sbapi.rst
    lldb/docs/design/structureddataplugins.md

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

Removed: 
    lldb/docs/resources/architecture.rst
    lldb/docs/resources/reproducers.rst
    lldb/docs/resources/sbapi.rst
    lldb/docs/resources/structureddataplugins.md


################################################################################
diff  --git a/lldb/docs/.htaccess b/lldb/docs/.htaccess
index 596f4481ab49..31b80359fb5f 100644
--- a/lldb/docs/.htaccess
+++ b/lldb/docs/.htaccess
@@ -1,3 +1,4 @@
+# Old website redirects
 Redirect 301 /architecture/index.html https://lldb.llvm.org/resources/architecture.html
 Redirect 301 /cpp_reference/html/index.html https://lldb.llvm.org/cpp_reference/index.html
 Redirect 301 /features.html https://lldb.llvm.org/status/features.html
@@ -10,7 +11,10 @@ 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
 
-# Sphinx redirects
+# Current website redirects
 Redirect 301 /resources/source.html https://lldb.llvm.org/resources/contributing.html
 Redirect 301 /resources/download.html https://lldb.llvm.org/status/releases.html
 Redirect 301 /use/architecture.html https://lldb.llvm.org/resources/architecture.html
+Redirect 301 /resources/architecture.html https://lldb.llvm.org/design/overview.html
+Redirect 301 /resources/reproducers.html https://lldb.llvm.org/design/reproducers.html
+Redirect 301 /resources/sbapi.html https://lldb.llvm.org/design/sbapi.html

diff  --git a/lldb/docs/resources/architecture.rst b/lldb/docs/design/overview.rst
similarity index 99%
rename from lldb/docs/resources/architecture.rst
rename to lldb/docs/design/overview.rst
index e87d1248d401..72eac56d6c3e 100644
--- a/lldb/docs/resources/architecture.rst
+++ b/lldb/docs/design/overview.rst
@@ -1,5 +1,5 @@
-Architecture
-============
+Overview
+========
 
 LLDB is a large and complex codebase. This section will help you become more
 familiar with the pieces that make up LLDB and give a general overview of the

diff  --git a/lldb/docs/resources/reproducers.rst b/lldb/docs/design/reproducers.rst
similarity index 100%
rename from lldb/docs/resources/reproducers.rst
rename to lldb/docs/design/reproducers.rst

diff  --git a/lldb/docs/resources/sbapi.rst b/lldb/docs/design/sbapi.rst
similarity index 99%
rename from lldb/docs/resources/sbapi.rst
rename to lldb/docs/design/sbapi.rst
index 048f6c12d972..674fd680b907 100644
--- a/lldb/docs/resources/sbapi.rst
+++ b/lldb/docs/design/sbapi.rst
@@ -1,5 +1,5 @@
-The SB API Coding Rules
-=======================
+Scripting Bridge API
+====================
 
 The SB APIs constitute the stable C++ API that lldb presents to external
 clients, and which get processed by SWIG to produce the Python bindings to

diff  --git a/lldb/docs/resources/structureddataplugins.md b/lldb/docs/design/structureddataplugins.md
similarity index 100%
rename from lldb/docs/resources/structureddataplugins.md
rename to lldb/docs/design/structureddataplugins.md

diff  --git a/lldb/docs/index.rst b/lldb/docs/index.rst
index 77c3dbbf6f74..909089f3cebe 100644
--- a/lldb/docs/index.rst
+++ b/lldb/docs/index.rst
@@ -140,16 +140,23 @@ interesting areas to contribute to lldb.
    :maxdepth: 1
    :caption: Development
 
-   resources/architecture
    resources/contributing
    resources/build
    resources/test
    resources/bots
-   resources/reproducers
-   resources/structureddataplugins
-   resources/sbapi
    resources/caveats
 
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Design
+
+   design/overview
+   design/reproducers
+   design/structureddataplugins
+   design/sbapi
+
 .. toctree::
    :hidden:
    :maxdepth: 1