summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorHeinrich Schuchardt <xypron.glpk@gmx.de>2020-05-09 07:33:43 +0200
committerHeinrich Schuchardt <xypron.glpk@gmx.de>2020-05-09 09:30:28 +0200
commit7fec249bb76db8bc21b98c08822116597154704d (patch)
treeffe82ac0825af20acfdc9f42f0abedd31ea0cc42 /doc/api
parente2a5b8603087bc3f8f9acd4cc171df48e7ef0a6a (diff)
downloadu-boot-7fec249bb76db8bc21b98c08822116597154704d.tar.gz
efi_selftest: add unit test functions to HTML documentation
Add the UEFI unit test helper functions to the generated HTML documentation. Correct some documentation texts in include/efi_selftest.h. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/efi.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api/efi.rst b/doc/api/efi.rst
index 0667c3aef7..d5114f05b3 100644
--- a/doc/api/efi.rst
+++ b/doc/api/efi.rst
@@ -163,3 +163,12 @@ Unicode Collation protocol
.. kernel-doc:: lib/efi_loader/efi_unicode_collation.c
:internal:
+
+Unit testing
+------------
+
+The following library functions are provided to support writing UEFI unit tests.
+The should not be used elsewhere.
+
+.. kernel-doc:: include/efi_selftest.h
+ :internal: