diff options
| author | fishsoupisgood <github@madingley.org> | 2019-04-29 01:17:54 +0100 | 
|---|---|---|
| committer | fishsoupisgood <github@madingley.org> | 2019-05-27 03:43:43 +0100 | 
| commit | 3f2546b2ef55b661fd8dd69682b38992225e86f6 (patch) | |
| tree | 65ca85f13617aee1dce474596800950f266a456c /roms/u-boot/doc/DocBook | |
| download | qemu-master.tar.gz qemu-master.tar.bz2 qemu-master.zip  | |
Diffstat (limited to 'roms/u-boot/doc/DocBook')
| -rw-r--r-- | roms/u-boot/doc/DocBook/.gitignore | 15 | ||||
| -rw-r--r-- | roms/u-boot/doc/DocBook/Makefile | 221 | ||||
| -rw-r--r-- | roms/u-boot/doc/DocBook/docbook.css | 16 | ||||
| -rw-r--r-- | roms/u-boot/doc/DocBook/linker_lists.tmpl | 46 | ||||
| -rw-r--r-- | roms/u-boot/doc/DocBook/stdio.tmpl | 46 | ||||
| -rw-r--r-- | roms/u-boot/doc/DocBook/stylesheet.xsl | 10 | 
6 files changed, 354 insertions, 0 deletions
diff --git a/roms/u-boot/doc/DocBook/.gitignore b/roms/u-boot/doc/DocBook/.gitignore new file mode 100644 index 00000000..7ebd5465 --- /dev/null +++ b/roms/u-boot/doc/DocBook/.gitignore @@ -0,0 +1,15 @@ +*.xml +*.ps +*.pdf +*.html +*.9.gz +*.9 +*.aux +*.dvi +*.log +*.out +*.png +*.gif +*.svg +media-indices.tmpl +media-entities.tmpl diff --git a/roms/u-boot/doc/DocBook/Makefile b/roms/u-boot/doc/DocBook/Makefile new file mode 100644 index 00000000..593237f0 --- /dev/null +++ b/roms/u-boot/doc/DocBook/Makefile @@ -0,0 +1,221 @@ +### +# This makefile is used to generate the kernel documentation, +# primarily based on in-line comments in various source files. +# See Documentation/kernel-doc-nano-HOWTO.txt for instruction in how +# to document the SRC - and how to read it. +# 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 + +### +# The build process is as follows (targets): +#              (xmldocs) [by docproc] +# file.tmpl --> file.xml +--> file.ps   (psdocs)   [by db2ps or xmlto] +#                        +--> file.pdf  (pdfdocs)  [by db2pdf or xmlto] +#                        +--> DIR=file  (htmldocs) [by xmlto] +#                        +--> man/      (mandocs)  [by xmlto] + + +# for PDF and PS output you can choose between xmlto and docbook-utils tools +PDF_METHOD	= $(prefer-db2x) +PS_METHOD	= $(prefer-db2x) + + +### +# The targets that may be used. +PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs + +targets += $(DOCBOOKS) +BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) +xmldocs: $(BOOKS) +sgmldocs: xmldocs + +PS := $(patsubst %.xml, %.ps, $(BOOKS)) +psdocs: $(PS) + +PDF := $(patsubst %.xml, %.pdf, $(BOOKS)) +pdfdocs: $(PDF) + +HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS))) +htmldocs: $(HTML) +	$(call build_main_index) +	$(call build_images) +	$(call install_media_images) + +MAN := $(patsubst %.xml, %.9, $(BOOKS)) +mandocs: $(MAN) +	$(if $(wildcard $(obj)/man/*.9),gzip -f $(obj)/man/*.9) + +installmandocs: mandocs +	mkdir -p /usr/local/man/man9/ +	install $(obj)/man/*.9.gz /usr/local/man/man9/ + +### +#External programs used +KERNELDOC = $(srctree)/scripts/kernel-doc +DOCPROC   = $(objtree)/scripts/docproc + +XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl +XMLTOFLAGS += --skip-validation + +### +# DOCPROC is used for two purposes: +# 1) To generate a dependency list for a .tmpl file +# 2) To preprocess a .tmpl file and call kernel-doc with +#     appropriate parameters. +# The following rules are used to generate the .xml documentation +# required to generate the final targets. (ps, pdf, html). +quiet_cmd_docproc = DOCPROC $@ +      cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@ +define rule_docproc +	set -e;								\ +        $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';) 	\ +        $(cmd_$(1)); 							\ +        ( 								\ +          echo 'cmd_$@ := $(cmd_$(1))'; 				\ +          echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; 		\ +        ) > $(dir $@).$(notdir $@).cmd +endef + +%.xml: %.tmpl $(KERNELDOC) $(DOCPROC) FORCE +	$(call if_changed_rule,docproc) + +# Tell kbuild to always build the programs +always := $(hostprogs-y) + +notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ +		   exit 1 +db2xtemplate = db2TYPE -o $(dir $@) $< +xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $< + +# determine which methods are available +ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found) +	use-db2x = db2x +	prefer-db2x = db2x +else +	use-db2x = notfound +	prefer-db2x = $(use-xmlto) +endif +ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found) +	use-xmlto = xmlto +	prefer-xmlto = xmlto +else +	use-xmlto = notfound +	prefer-xmlto = $(use-db2x) +endif + +# the commands, generated from the chosen template +quiet_cmd_db2ps = PS      $@ +      cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template)) +%.ps : %.xml +	$(call cmd,db2ps) + +quiet_cmd_db2pdf = PDF     $@ +      cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template)) +%.pdf : %.xml +	$(call cmd,db2pdf) + + +index = index.html +main_idx = $(obj)/$(index) +build_main_index = rm -rf $(main_idx); \ +		   echo '<h1>U-Boot Bootloader HTML Documentation</h1>' >> $(main_idx) && \ +		   echo '<h2>U-Boot Version: $(UBOOTVERSION)</h2>' >> $(main_idx) && \ +		   cat $(HTML) >> $(main_idx) + +quiet_cmd_db2html = HTML    $@ +      cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ +		echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ +		$(patsubst %.html,%,$(notdir $@))</a><p>' > $@ + +%.html:	%.xml +	@(which xmlto > /dev/null 2>&1) || \ +	 (echo "*** You need to install xmlto ***"; \ +	  exit 1) +	@rm -rf $@ $(patsubst %.html,%,$@) +	$(call cmd,db2html) +	@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ +            cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi + +quiet_cmd_db2man = MAN     $@ +      cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; fi +%.9 : %.xml +	@(which xmlto > /dev/null 2>&1) || \ +	 (echo "*** You need to install xmlto ***"; \ +	  exit 1) +	$(Q)mkdir -p $(obj)/man +	$(call cmd,db2man) +	@touch $@ + +### +# Rules to generate postscripts and PNG images from .fig format files +quiet_cmd_fig2eps = FIG2EPS $@ +      cmd_fig2eps = fig2dev -Leps $< $@ + +%.eps: %.fig +	@(which fig2dev > /dev/null 2>&1) || \ +	 (echo "*** You need to install transfig ***"; \ +	  exit 1) +	$(call cmd,fig2eps) + +quiet_cmd_fig2png = FIG2PNG $@ +      cmd_fig2png = fig2dev -Lpng $< $@ + +%.png: %.fig +	@(which fig2dev > /dev/null 2>&1) || \ +	 (echo "*** You need to install transfig ***"; \ +	  exit 1) +	$(call cmd,fig2png) + +### +# Rule to convert a .c file to inline XML documentation +       gen_xml = : + quiet_gen_xml = echo '  GEN     $@' +silent_gen_xml = : +%.xml: %.c +	@$($(quiet)gen_xml) +	@(                            \ +	   echo "<programlisting>";   \ +	   expand --tabs=8 < $< |     \ +	   sed -e "s/&/\\&/g"     \ +	       -e "s/</\\</g"      \ +	       -e "s/>/\\>/g";     \ +	   echo "</programlisting>")  > $@ + +### +# Help targets as used by the top-level makefile +dochelp: +	@echo  ' U-Boot bootloader internal documentation in different formats:' +	@echo  '  htmldocs        - HTML' +	@echo  '  pdfdocs         - PDF' +	@echo  '  psdocs          - Postscript' +	@echo  '  xmldocs         - XML DocBook' +	@echo  '  mandocs         - man pages' +	@echo  '  installmandocs  - install man pages generated by mandocs' +	@echo  '  cleandocs       - clean all generated DocBook files' + +### +# Temporary files left by various tools +clean-files := $(DOCBOOKS) \ +	$(patsubst %.xml, %.dvi,  $(DOCBOOKS)) \ +	$(patsubst %.xml, %.aux,  $(DOCBOOKS)) \ +	$(patsubst %.xml, %.tex,  $(DOCBOOKS)) \ +	$(patsubst %.xml, %.log,  $(DOCBOOKS)) \ +	$(patsubst %.xml, %.out,  $(DOCBOOKS)) \ +	$(patsubst %.xml, %.ps,   $(DOCBOOKS)) \ +	$(patsubst %.xml, %.pdf,  $(DOCBOOKS)) \ +	$(patsubst %.xml, %.html, $(DOCBOOKS)) \ +	$(patsubst %.xml, %.9,    $(DOCBOOKS)) \ +	$(index) + +clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man + +cleandocs: +	$(Q)rm -f $(call objectify, $(clean-files)) +	$(Q)rm -rf $(call objectify, $(clean-dirs)) + +# Declare the contents of the .PHONY variable as phony.  We keep that +# information in a variable se we can use it in if_changed and friends. + +.PHONY: $(PHONY) diff --git a/roms/u-boot/doc/DocBook/docbook.css b/roms/u-boot/doc/DocBook/docbook.css new file mode 100644 index 00000000..7a79ec54 --- /dev/null +++ b/roms/u-boot/doc/DocBook/docbook.css @@ -0,0 +1,16 @@ +body { +	font-family:		sans-serif; +} + +.programlisting { +	font-family:		monospace; +	font-size:		1em; +	display:		block; +	padding:		10px; +	border:			1px solid #aaa; +	color:			#000; +	background-color:	#eee; +	overflow:		auto; +	margin:			1em 0em; +	border-radius:		6px; +} diff --git a/roms/u-boot/doc/DocBook/linker_lists.tmpl b/roms/u-boot/doc/DocBook/linker_lists.tmpl new file mode 100644 index 00000000..f1975165 --- /dev/null +++ b/roms/u-boot/doc/DocBook/linker_lists.tmpl @@ -0,0 +1,46 @@ +<?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="UBootLGArrays"> + <bookinfo> +  <title>The U-Boot Linker-Generated Arrays</title> + +  <legalnotice> +   <para> +     This documentation is free software; you can redistribute +     it and/or modify it under the terms of the GNU General Public +     License as published by the Free Software Foundation; either +     version 2 of the License, or (at your option) any later +     version. +   </para> + +   <para> +     This program is distributed in the hope that it will be +     useful, but WITHOUT ANY WARRANTY; without even the implied +     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +     See the GNU General Public License for more details. +   </para> + +   <para> +     You should have received a copy of the GNU General Public +     License along with this program; if not, write to the Free +     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, +     MA 02111-1307 USA +   </para> + +   <para> +     For more details see the file COPYING in the source +     distribution of U-Boot Bootloader. +   </para> +  </legalnotice> + </bookinfo> + +<toc></toc> + +  <chapter id="adt"> +     <title>Linker-Generated Arrays</title> +!Iinclude/linker_lists.h +  </chapter> + +</book> diff --git a/roms/u-boot/doc/DocBook/stdio.tmpl b/roms/u-boot/doc/DocBook/stdio.tmpl new file mode 100644 index 00000000..4783abb0 --- /dev/null +++ b/roms/u-boot/doc/DocBook/stdio.tmpl @@ -0,0 +1,46 @@ +<?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="UBootSTDIO"> + <bookinfo> +  <title>The U-Boot STDIO subsystem</title> + +  <legalnotice> +   <para> +     This documentation is free software; you can redistribute +     it and/or modify it under the terms of the GNU General Public +     License as published by the Free Software Foundation; either +     version 2 of the License, or (at your option) any later +     version. +   </para> + +   <para> +     This program is distributed in the hope that it will be +     useful, but WITHOUT ANY WARRANTY; without even the implied +     warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +     See the GNU General Public License for more details. +   </para> + +   <para> +     You should have received a copy of the GNU General Public +     License along with this program; if not, write to the Free +     Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, +     MA 02111-1307 USA +   </para> + +   <para> +     For more details see the file COPYING in the source +     distribution of U-Boot Bootloader. +   </para> +  </legalnotice> + </bookinfo> + +<toc></toc> + +  <chapter id="adt"> +     <title>U-Boot Serial subsystem</title> +!Idrivers/serial/serial.c +  </chapter> + +</book> diff --git a/roms/u-boot/doc/DocBook/stylesheet.xsl b/roms/u-boot/doc/DocBook/stylesheet.xsl new file mode 100644 index 00000000..85b25275 --- /dev/null +++ b/roms/u-boot/doc/DocBook/stylesheet.xsl @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<stylesheet xmlns="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<param name="chunk.quietly">1</param> +<param name="funcsynopsis.style">ansi</param> +<param name="funcsynopsis.tabular.threshold">80</param> +<param name="callout.graphics">0</param> +<!-- <param name="paper.type">A4</param> --> +<param name="generate.section.toc.level">2</param> +<param name="use.id.as.filename">1</param> +</stylesheet>  | 
