u-boot/doc/api/index.rst

.. SPDX-License-Identifier: GPL-2.0+

U-Boot API documentation
========================

.. toctree::
   :maxdepth: 2

   dfu
   efi
   getopt
   linker_lists
   logging
   pinctrl
   rng
   sandbox
   serial
   sysreset
   timer
   unicode
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2019-07-18 07:33:46 +00:00			`.. SPDX-License-Identifier: GPL-2.0+`

			`U-Boot API documentation`
			`========================`

			`.. toctree::`
			`:maxdepth: 2`

doc: dfu: add DFU to HTML documentation Add the device firmware update functions to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Acked-by: Lukasz Majewski <lukma@denx.de> 2020-05-23 10:01:08 +00:00			`dfu`
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2019-07-18 07:33:46 +00:00			`efi`
lib: Add getopt Some commands can get very unweildy if they have too many positional arguments. Adding options makes them easier to read, remember, and understand. This implementation of getopt has been taken from barebox, which has had option support for quite a while. I have made a few modifications to their version, such as the removal of opterr in favor of a separate getopt_silent function. In addition, I have moved all global variables into struct getopt_context. The getopt from barebox also re-orders the arguments passed to it so that non-options are placed last. This allows users to specify options anywhere. For example, `ls -l foo/ -R` would be re-ordered to `ls -l -R foo/` as getopt parsed the options. However, this feature conflicts with the const argv in cmd_tbl->cmd. This was originally added in 54841ab50c ("Make sure that argv[] argument pointers are not modified."). The reason stated in that commit is that hush requires argv to stay unmodified. Has this situation changed? Barebox also uses hush, and does not have this problem. Perhaps we could use their fix? I have assigned maintenance of getopt to Simon Glass, as it is currently only used by the log command. I would also be fine maintaining it. Signed-off-by: Sean Anderson <seanga2@gmail.com> 2020-10-27 23:55:36 +00:00			`getopt`
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2019-07-18 07:33:46 +00:00			`linker_lists`
doc: fix doc/develop/logging.rst Sphinx 3 builds fail due to doc/develop/logging.rst producing duplicate labels. Include logging.h only once in the API section and use cross-references for the enums log_level_t and log_category_t. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2021-01-25 20:06:57 +00:00			`logging`
pinctrl: Reformat documentation in dm/pinctrl.h This normalizes the documentation to conform to kernel-doc style [1]. It also moves the documentation for pinctrl_ops inline, and adds argument and return-value documentation. I have kept the usual function style for these comments. I could not find any existing examples of function documentation inside structs. [1] https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org> 2020-09-14 15:01:56 +00:00			`pinctrl`
doc: random number generation Add random number generation APIs to the HTML documentation. Fix style issues. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2020-06-13 10:29:52 +00:00			`rng`
doc: add sandbox API Add sandbox API to generated HTML documentation Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org> 2020-10-27 19:29:28 +00:00			`sandbox`
doc: Move existing rst files into api sub-directory Currently the Sphinx doc only contains API descriptions of several U-Boot subsystems. For future extension, group these existing docs into an API sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2019-07-18 07:33:46 +00:00			`serial`
doc: add system reset to API documentation Complete the Sphinx documentation in include/sysreset.h Add the include to the generated HTML documentation of the U-Boot API. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> 2021-09-23 09:06:16 +00:00			`sysreset`
doc: Document timer API This adds kerneldocs for <timer.h>. I don't know who should maintain doc/api/timer.rst, since the timer subsystem seems to be maintained by SoC maintainers. MAINTAINERS is left un-updated for the moment. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org> 2020-10-07 18:37:43 +00:00			`timer`
doc: add Unicode functions to API description Add include/charset.h to generated HTML documentation Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> 2020-05-09 07:00:59 +00:00			`unicode`