Skip to contentSkip to conversation

move test related documentation to HTML

PATCH New Heinrich Schuchardt 3 participants 10 messages Jan 18, 2021 – Jan 23, 2021

lore
Share & tools
lore
#0 lore raw

cover move test related documentation to HTML

Restructure doc/develop/index.rst and move test related READMEs to the generated HTML documentation.

Heinrich Schuchardt (3):
doc: structure doc/develop/index.rst
doc: move test/README to HTML documentation
doc: move test/py/README.md to HTML documentation

 doc/develop/index.rst      |  24 ++-
 doc/develop/py_testing.rst | 426 +++++++++++++++++++++++++++++++++++++
 doc/develop/testing.rst    |  96 +++++++++
 test/README                |  96 ---------
 test/py/README.md          | 389 ---------------------------------
 5 files changed, 543 insertions(+), 488 deletions(-)
 create mode 100644 doc/develop/py_testing.rst
 create mode 100644 doc/develop/testing.rst
 delete mode 100644 test/README
 delete mode 100644 test/py/README.md

--
2.29.2

#1 lore raw

PATCH 1/3 doc: structure doc/develop/index.rst

Provide sub-chapters for 'Develop U-Boot'

---
 doc/develop/index.rst | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)
doc/develop/index.rst +19 -3
index 0a7e204b34..b108df8e1b 100644
@@ -3,13 +3,29 @@
 Develop U-Boot
 ==============
 
+Implementation
+--------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   coccinelle
    commands
-   crash_dumps
    global_data
    logging
+
+Debugging
+---------
+
+.. toctree::
+   :maxdepth: 1
+
+   crash_dumps
    trace
+
+Testing
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+   coccinelle

--
2.29.2

#3 lore raw

PATCH 1/3 doc: structure doc/develop/index.rst

In reply to Heinrich Schuchardt
Quoted 4 lines · Heinrich Schuchardt

Provide sub-chapters for 'Develop U-Boot'

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210123/377754c5/attachment.sig>
#4 lore raw

PATCH 2/3 doc: move test/README to HTML documentation

In reply to Heinrich Schuchardt

Move test/README to the 'Develop U-Boot' chapter of the HTML documentation.

---
 doc/develop/index.rst   |  1 +
 doc/develop/testing.rst | 96 +++++++++++++++++++++++++++++++++++++++++
 test/README             | 96 -----------------------------------------
 3 files changed, 97 insertions(+), 96 deletions(-)
 create mode 100644 doc/develop/testing.rst
 delete mode 100644 test/README
doc/develop/index.rst +1 -0
index b108df8e1b..ed2e73bf56 100644
@@ -29,3 +29,4 @@ Testing
    :maxdepth: 1
 
    coccinelle
+   testing
doc/develop/testing.rst new file +96 -0

96 lines not on this page · raw message

test/README deleted +0 -96

96 lines not on this page · raw message

--
2.29.2

#5 lore raw

PATCH 2/3 doc: move test/README to HTML documentation

Quoted 11 lines · Heinrich Schuchardt

Move test/README to the 'Develop U-Boot' chapter of the HTML documentation.

---
 doc/develop/index.rst   |  1 +
 doc/develop/testing.rst | 96 +++++++++++++++++++++++++++++++++++++++++
 test/README             | 96 -----------------------------------------
 3 files changed, 97 insertions(+), 96 deletions(-)
 create mode 100644 doc/develop/testing.rst
 delete mode 100644 test/README
#6 lore raw

PATCH 2/3 doc: move test/README to HTML documentation

In reply to Heinrich Schuchardt
Quoted 4 lines · Heinrich Schuchardt

Move test/README to the 'Develop U-Boot' chapter of the HTML documentation.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210123/b5e18ca6/attachment.sig>
#7 lore raw

PATCH 3/3 doc: move test/py/README.md to HTML documentation

In reply to Heinrich Schuchardt

Convert test/py/README.md to restructured text and add it to the generated HTML documentation.

---
 doc/develop/index.rst      |   1 +
 doc/develop/py_testing.rst | 426 +++++++++++++++++++++++++++++++++++++
 test/py/README.md          | 389 ---------------------------------
 3 files changed, 427 insertions(+), 389 deletions(-)
 create mode 100644 doc/develop/py_testing.rst
 delete mode 100644 test/py/README.md
doc/develop/index.rst +1 -0
index ed2e73bf56..83eb1307ed 100644
@@ -30,3 +30,4 @@ Testing
 
    coccinelle
    testing
+   py_testing
doc/develop/py_testing.rst new file +426 -0

426 lines not on this page · raw message

test/py/README.md deleted +0 -389

389 lines not on this page · raw message

--
2.29.2

#8 lore raw

PATCH 3/3 doc: move test/py/README.md to HTML documentation

Quoted 4 lines · Heinrich Schuchardt

Convert test/py/README.md to restructured text and add it to the generated HTML documentation.

Quoted 9 lines
---
 doc/develop/index.rst      |   1 +
 doc/develop/py_testing.rst | 426 +++++++++++++++++++++++++++++++++++++
 test/py/README.md          | 389 ---------------------------------
 3 files changed, 427 insertions(+), 389 deletions(-)
 create mode 100644 doc/develop/py_testing.rst
 delete mode 100644 test/py/README.md
#9 lore raw

PATCH 3/3 doc: move test/py/README.md to HTML documentation

In reply to Heinrich Schuchardt
Quoted 5 lines · Heinrich Schuchardt

Convert test/py/README.md to restructured text and add it to the generated HTML documentation.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210123/0a3c915d/attachment.sig>