diff options
| author | Sam Ravnborg <sam@mars.ravnborg.org> | 2003-06-21 13:42:23 +0200 |
|---|---|---|
| committer | Sam Ravnborg <sam@mars.ravnborg.org> | 2003-06-21 13:42:23 +0200 |
| commit | cc79cb641b86d9002528b3403a6db820049ddc22 (patch) | |
| tree | de8b201ec9d4f6642b8cea3c15fe65d26b13e5d6 /Makefile | |
| parent | ee598aceb228acf07019c3706a76c016279f6317 (diff) | |
| download | history-cc79cb641b86d9002528b3403a6db820049ddc22.tar.gz | |
docbook: Added support for generating man files
Originally by Michael Still <mikal@stillhq.com>
This patch adds two new targets to the docbook makefile -- mandocs, and
installmandocs. The targets require two new perl scripts in the scripts/
directory, but in return we get a series of man pages for kernel
functions, which are installed in man section 9. This is a good thing, as
many programmers expect documentation to be available with man, and
hunting through various PS or PDF documents to find the documentation for
the function you want can be quite frustrating.
The man pages are just extracted from the various existing DocBook SGML
documents, which are generated by kernel-doc. You also need to have
docbook2man installed on your machine.
Please note the formatting is not perfect, but I will tweak
other stuff later with further patches -- this is just an initial
implementation.
Sample output (HTMLised) can be found at
http://www.stillhq.com/linux/mandocs/2.5.68/ and
http://www.stillhq.com/linux/mandocs/2.5.70/
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Makefile b/Makefile index a22f6ebe21e2a2..1cf2209817efd1 100644 --- a/Makefile +++ b/Makefile @@ -236,7 +236,7 @@ depfile = $(subst $(comma),_,$(@D)/.$(@F).d) noconfig_targets := xconfig gconfig menuconfig config oldconfig randconfig \ defconfig allyesconfig allnoconfig allmodconfig \ clean mrproper distclean rpm \ - help tags TAGS cscope sgmldocs psdocs pdfdocs htmldocs \ + help tags TAGS cscope %docs \ checkconfig checkhelp checkincludes RCS_FIND_IGNORE := \( -name SCCS -o -name BitKeeper -o -name .svn -o -name CVS \) -prune -o @@ -833,7 +833,7 @@ help: # Documentation targets # --------------------------------------------------------------------------- -sgmldocs psdocs pdfdocs htmldocs: scripts/docproc FORCE +%docs: scripts/docproc FORCE $(Q)$(MAKE) $(build)=Documentation/DocBook $@ # Scripts to check various things for consistency |