Bläddra i källkod

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>
Heinrich Schuchardt 6 år sedan
förälder
incheckning
6b03cd107e
4 ändrade filer med 283 tillägg och 248 borttagningar
  1. 1 0
      MAINTAINERS
  2. 1 1
      doc/DocBook/Makefile
  3. 17 0
      doc/DocBook/efi.tmpl
  4. 264 247
      lib/efi_loader/efi_boottime.c

+ 1 - 0
MAINTAINERS

@@ -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*

+ 1 - 1
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):

+ 17 - 0
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>

Filskillnaden har hållts tillbaka eftersom den är för stor
+ 264 - 247
lib/efi_loader/efi_boottime.c


Vissa filer visades inte eftersom för många filer har ändrats