diff options
| author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2023-08-15 12:30:19 +0200 |
|---|---|---|
| committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2023-08-15 18:21:17 +0200 |
| commit | 5aae021c30940a57862c1ea6a3cf8eeb88ca2c1c (patch) | |
| tree | 21e04e936c80d7b82fbcff5f4cda186b37b70137 /doc/api | |
| parent | 289bd72ea41fd45237a34593065ff107afc2a9a9 (diff) | |
doc: add partition API to HTML documentation
* Convert comments in part.h to Sphinx style.
* Create documentation page for the partition API.
* Add the partition API page to the API index page.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/index.rst | 1 | ||||
| -rw-r--r-- | doc/api/part.rst | 6 |
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst index a9338cfef9f..3a80ae0635a 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -15,6 +15,7 @@ U-Boot API documentation lmb logging nvmem + part pinctrl rng sandbox diff --git a/doc/api/part.rst b/doc/api/part.rst new file mode 100644 index 00000000000..d1df1d84945 --- /dev/null +++ b/doc/api/part.rst @@ -0,0 +1,6 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Partition API +============= + +.. kernel-doc:: include/part.h |