diff mbox series

[v3,8/8] doc: add sandbox API

Message ID 20201027192928.16508-9-xypron.glpk@gmx.de
State Accepted
Commit 0ae9bc3c42f1e47ac4954bc3b3112067e15bb6f3
Delegated to: Simon Glass
Headers show
Series sandbox: implement cold reset | expand

Commit Message

Heinrich Schuchardt Oct. 27, 2020, 7:29 p.m. UTC
Add sandbox API to generated HTML documentation

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
v3:
	no change
v2:
	new patch
---
 doc/api/index.rst   | 1 +
 doc/api/sandbox.rst | 9 +++++++++
 2 files changed, 10 insertions(+)
 create mode 100644 doc/api/sandbox.rst

--
2.28.0

Comments

Simon Glass Nov. 3, 2020, 12:06 a.m. UTC | #1
On Tue, 27 Oct 2020 at 13:29, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Add sandbox API to generated HTML documentation
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
> v3:
>         no change
> v2:
>         new patch
> ---
>  doc/api/index.rst   | 1 +
>  doc/api/sandbox.rst | 9 +++++++++
>  2 files changed, 10 insertions(+)
>  create mode 100644 doc/api/sandbox.rst

Reviewed-by: Simon Glass <sjg@chromium.org>
Simon Glass Nov. 3, 2020, 11:03 p.m. UTC | #2
On Tue, 27 Oct 2020 at 13:29, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Add sandbox API to generated HTML documentation
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
> v3:
>         no change
> v2:
>         new patch
> ---
>  doc/api/index.rst   | 1 +
>  doc/api/sandbox.rst | 9 +++++++++
>  2 files changed, 10 insertions(+)
>  create mode 100644 doc/api/sandbox.rst

Reviewed-by: Simon Glass <sjg@chromium.org>

Applied to u-boot-dm, thanks!
diff mbox series

Patch

diff --git a/doc/api/index.rst b/doc/api/index.rst
index 787b6778e5..cc3bce494e 100644
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -11,6 +11,7 @@  U-Boot API documentation
    linker_lists
    pinctrl
    rng
+   sandbox
    serial
    timer
    unicode
diff --git a/doc/api/sandbox.rst b/doc/api/sandbox.rst
new file mode 100644
index 0000000000..724776399b
--- /dev/null
+++ b/doc/api/sandbox.rst
@@ -0,0 +1,9 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+Sandbox
+=======
+
+The following API routines are used to implement the U-Boot sandbox.
+
+.. kernel-doc:: include/os.h
+   :internal: