This revision was automatically updated to reflect the committed changes.
Closed by commit rG128e999d63c4: [lldb] Add a "design" section to the
documentation. (authored by JDevlieghere).
Herald added a project: LLDB.
Changed prior to commit:
https://reviews.llvm.org/D88516?vs=295873&id=295897#toc
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D88516/new/
https://reviews.llvm.org/D88516
Files:
lldb/docs/.htaccess
lldb/docs/design/overview.rst
lldb/docs/design/reproducers.rst
lldb/docs/design/sbapi.rst
lldb/docs/design/structureddataplugins.md
lldb/docs/index.rst
lldb/docs/resources/architecture.rst
lldb/docs/resources/reproducers.rst
lldb/docs/resources/sbapi.rst
lldb/docs/resources/structureddataplugins.md
Index: lldb/docs/index.rst
===================================================================
--- lldb/docs/index.rst
+++ lldb/docs/index.rst
@@ -140,16 +140,23 @@
: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
Index: lldb/docs/design/sbapi.rst
===================================================================
--- lldb/docs/design/sbapi.rst
+++ 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
Index: lldb/docs/design/overview.rst
===================================================================
--- lldb/docs/design/overview.rst
+++ 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
Index: lldb/docs/.htaccess
===================================================================
--- lldb/docs/.htaccess
+++ 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 /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
Index: lldb/docs/index.rst
===================================================================
--- lldb/docs/index.rst
+++ lldb/docs/index.rst
@@ -140,16 +140,23 @@
: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
Index: lldb/docs/design/sbapi.rst
===================================================================
--- lldb/docs/design/sbapi.rst
+++ 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
Index: lldb/docs/design/overview.rst
===================================================================
--- lldb/docs/design/overview.rst
+++ 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
Index: lldb/docs/.htaccess
===================================================================
--- lldb/docs/.htaccess
+++ 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 /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
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
