summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2022-01-12 19:26:24 -0700
committerSimon Glass <sjg@chromium.org>2022-01-13 09:13:41 -0700
commit20a149353097967cfac3ec1a77eab08215427b0d (patch)
tree626fb53ca25f1db7a799f4dd2aa5c31e3db7d082 /doc
parente50a24a0456c07d28c0d589e061dd0576f6bb917 (diff)
bloblist: doc: Bring in the API documentation
FIx up various minor errors and add the API documentation to the bloblist docs, since it is quite useful to see it in the same place. Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/develop/bloblist.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/develop/bloblist.rst b/doc/develop/bloblist.rst
index 47274cf8e2..572aa65d76 100644
--- a/doc/develop/bloblist.rst
+++ b/doc/develop/bloblist.rst
@@ -31,7 +31,7 @@ Blobs
While each blob in the bloblist can be of any length, bloblists are designed to
hold small amounts of data, typically a few KB at most. It is not possible to
change the length of a blob once it has been written. Each blob is normally
-created from a C structure which can beused to access its fields.
+created from a C structure which can be used to access its fields.
Blob tags
@@ -93,6 +93,12 @@ This should move to using bloblist, to avoid having its own mechanism for
passing information between U-Boot parts.
+API documentation
+-----------------
+
+.. kernel-doc:: include/bloblist.h
+
+
Simon Glass
sjg@chromium.org
12-Aug-2018