diff mbox series

[22/35] bloblist: Move to rST format

Message ID 20210908133405.696481-7-sjg@chromium.org
State Accepted, archived
Commit 4d7bb45dc4ddb596e4b4ce6714884ddb0b757df8
Delegated to: Heinrich Schuchardt
Headers show
Series efi: Improvements to U-Boot running on top of UEFI | expand

Commit Message

Simon Glass Sept. 8, 2021, 1:33 p.m. UTC
Move this documentation to the new format.

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

 doc/{README.bloblist => develop/bloblist.rst} | 4 ++--
 doc/develop/index.rst                         | 1 +
 2 files changed, 3 insertions(+), 2 deletions(-)
 rename doc/{README.bloblist => develop/bloblist.rst} (97%)

Comments

Heinrich Schuchardt Sept. 8, 2021, 6:18 p.m. UTC | #1
On 9/8/21 3:33 PM, Simon Glass wrote:
> Move this documentation to the new format.
>
> Signed-off-by: Simon Glass <sjg@chromium.org>

Acked-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> ---
>
>   doc/{README.bloblist => develop/bloblist.rst} | 4 ++--
>   doc/develop/index.rst                         | 1 +
>   2 files changed, 3 insertions(+), 2 deletions(-)
>   rename doc/{README.bloblist => develop/bloblist.rst} (97%)
>
> diff --git a/doc/README.bloblist b/doc/develop/bloblist.rst
> similarity index 97%
> rename from doc/README.bloblist
> rename to doc/develop/bloblist.rst
> index 274c4605571..317ebc4919d 100644
> --- a/doc/README.bloblist
> +++ b/doc/develop/bloblist.rst
> @@ -1,4 +1,4 @@
> -# SPDX-License-Identifier: GPL-2.0+
> +.. SPDX-License-Identifier: GPL-2.0+
>
>   Blob Lists - bloblist
>   =====================
> @@ -39,7 +39,7 @@ Blob tags
>
>   Each blob has a tag which is a 32-bit number. This uniquely identifies the
>   owner of the blob. Blob tags are listed in enum blob_tag_t and are named
> -with a BLOBT_ prefix.
> +with a `BLOBT_` prefix.
>
>
>   Single structure
> diff --git a/doc/develop/index.rst b/doc/develop/index.rst
> index 83c929babda..2a32645cfd2 100644
> --- a/doc/develop/index.rst
> +++ b/doc/develop/index.rst
> @@ -9,6 +9,7 @@ Implementation
>   .. toctree::
>      :maxdepth: 1
>
> +   bloblist
>      ci_testing
>      commands
>      devicetree/index
>
diff mbox series

Patch

diff --git a/doc/README.bloblist b/doc/develop/bloblist.rst
similarity index 97%
rename from doc/README.bloblist
rename to doc/develop/bloblist.rst
index 274c4605571..317ebc4919d 100644
--- a/doc/README.bloblist
+++ b/doc/develop/bloblist.rst
@@ -1,4 +1,4 @@ 
-# SPDX-License-Identifier: GPL-2.0+
+.. SPDX-License-Identifier: GPL-2.0+
 
 Blob Lists - bloblist
 =====================
@@ -39,7 +39,7 @@  Blob tags
 
 Each blob has a tag which is a 32-bit number. This uniquely identifies the
 owner of the blob. Blob tags are listed in enum blob_tag_t and are named
-with a BLOBT_ prefix.
+with a `BLOBT_` prefix.
 
 
 Single structure
diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 83c929babda..2a32645cfd2 100644
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -9,6 +9,7 @@  Implementation
 .. toctree::
    :maxdepth: 1
 
+   bloblist
    ci_testing
    commands
    devicetree/index