This patch series implants slightly modified kernel-doc documentation
generator from Linux kernel into U-Boot. First patch pulls in all the
necessary components with minor modifications made to them to work with
the layout of U-Boot source tree and without kbuild.
Further patch implement CSS to make the HTML documentation look a bit
nicer. This patch will eventually (hopefully) be further refined by
someone more artistically capable than me ;-)
Next patch implements separate handling for "Example:" section, which
in the original kernel-doc was in my opinion mistreated. The example
section generated a block of code, but the indentation was removed.
Thus this patch does avoid removing the indent.
Finally, the last patch implements example of how to use this kernel-doc
to generate U-Boot documentation by documenting the Linker-Generated
arrays.
NOTE: This patchset (last patch) has a cross-dependency on:
[PATCH 0/5] Linker-generated arrays (take 2)
V2: Add proper .gitignore entries, fix build issues (fix Makefiles)
Marek Vasut (4):
doc: kerneldoc: Implant DocBook from Linux kernel
doc: kerneldoc: Add nicer CSS stylesheet for HTML docs
doc: kerneldoc: Implement "Example" section handling
doc: kerneldoc: tmpl: Implement template for LG-arrays
Makefile | 7 +-
doc/DocBook/.gitignore | 15 +
doc/DocBook/Makefile | 229 ++++
doc/DocBook/docbook.css | 16 +
doc/DocBook/linker_lists.tmpl | 46 +
doc/DocBook/stylesheet.xsl | 11 +
tools/.gitignore | 1 +
tools/Makefile | 2 +-
tools/kernel-doc/Makefile | 38 +
tools/kernel-doc/docproc.c | 576 ++++++++++
tools/kernel-doc/kernel-doc | 2557 +++++++++++++++++++++++++++++++++++++++++
11 files changed, 3496 insertions(+), 2 deletions(-)
create mode 100644 doc/DocBook/.gitignore
create mode 100644 doc/DocBook/Makefile
create mode 100644 doc/DocBook/docbook.css
create mode 100644 doc/DocBook/linker_lists.tmpl
create mode 100644 doc/DocBook/stylesheet.xsl
create mode 100644 tools/kernel-doc/Makefile
create mode 100644 tools/kernel-doc/docproc.c
create mode 100755 tools/kernel-doc/kernel-doc
Cc: Joe Hershberger <joe.hershber...@gmail.com>
Cc: Mike Frysinger <vap...@gentoo.org>
--
1.7.10.4
_______________________________________________
U-Boot mailing list
U-Boot@lists.denx.de
http://lists.denx.de/mailman/listinfo/u-boot
