diff options
| author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2018-05-11 18:15:41 +0200 |
|---|---|---|
| committer | Alexander Graf <agraf@suse.de> | 2018-06-03 15:27:21 +0200 |
| commit | 6b03cd107ece1fb6c84ce9ef2958b6cc1563367c (patch) | |
| tree | fe0105b80c970bfca56e26980780961421e698c5 /doc | |
| parent | 896019b18b0a6f9392fa234c082ef492e1630cc3 (diff) | |
| download | u-boot-6b03cd107ece1fb6c84ce9ef2958b6cc1563367c.zip u-boot-6b03cd107ece1fb6c84ce9ef2958b6cc1563367c.tar.gz u-boot-6b03cd107ece1fb6c84ce9ef2958b6cc1563367c.tar.bz2 | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/DocBook/Makefile | 2 | ||||
| -rw-r--r-- | doc/DocBook/efi.tmpl | 17 |
2 files changed, 18 insertions, 1 deletions
diff --git a/doc/DocBook/Makefile b/doc/DocBook/Makefile index 820b1fb..5257613 100644 --- a/doc/DocBook/Makefile +++ b/doc/DocBook/Makefile @@ -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): diff --git a/doc/DocBook/efi.tmpl b/doc/DocBook/efi.tmpl new file mode 100644 index 0000000..5daaae3 --- /dev/null +++ b/doc/DocBook/efi.tmpl @@ -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> |