efi_loader: DocBook comments for boot services

With 'make htmldocs' we can generate a documentation if the function
comments follow the DocBook conventions.

This patch adjusts the comments for EFI boot services and provides the
DocBook template for the EFI subsystem.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Signed-off-by: Alexander Graf <agraf@suse.de>
This commit is contained in:
Heinrich Schuchardt 2018-05-11 18:15:41 +02:00 committed by Alexander Graf
parent 896019b18b
commit 6b03cd107e
4 changed files with 455 additions and 397 deletions

View File

@ -342,6 +342,7 @@ EFI PAYLOAD
M: Alexander Graf <agraf@suse.de>
S: Maintained
T: git git://github.com/agraf/u-boot.git
F: doc/DocBook/efi.tmpl
F: doc/README.uefi
F: doc/README.iscsi
F: include/efi*

View File

@ -7,7 +7,7 @@
# To add a new book the only step required is to add the book to the
# list of DOCBOOKS.
DOCBOOKS := linker_lists.xml stdio.xml
DOCBOOKS := efi.xml linker_lists.xml stdio.xml
###
# The build process is as follows (targets):

17
doc/DocBook/efi.tmpl Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<book id="UBootEFI">
<bookinfo>
<title>The U-Boot EFI subsystem</title>
</bookinfo>
<toc></toc>
<chapter id="BootServices">
<title>Boot services</title>
!Ilib/efi_loader/efi_boottime.c
</chapter>
</book>

File diff suppressed because it is too large Load Diff