From becc5c626d5bc6fad8d54220523c8a7e1d7fd5c5 Mon Sep 17 00:00:00 2001 From: Alexander Leidinger Date: Fri, 26 May 2006 18:10:06 +0000 Subject: [PATCH] Connect the kernel subsystem API documentation generation framework to the build infrastructure: "make doxygen" Changes to the man pages will be made when some defaults are revisited. Requested by: gnn --- Makefile | 9 +++++---- Makefile.inc1 | 13 +++++++++++++ 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 37a21bc78f8a..49c702a6db83 100644 --- a/Makefile +++ b/Makefile @@ -15,6 +15,7 @@ # reinstallkernel - Reinstall the kernel and the kernel-modules. # reinstallkernel.debug # kernel - buildkernel + installkernel. +# doxygen - Build API documentation of the kernel, needs doxygen. # update - Convenient way to update your source tree (cvs). # check-old - Print a list of old files/directories in the system. # delete-old - Delete obsolete files and directories interactively. @@ -69,10 +70,10 @@ # TGTS= all all-man buildenv buildkernel buildworld check-old checkdpadd \ clean cleandepend cleandir delete-old delete-old-libs depend \ - distribute distributeworld distrib-dirs distribution everything \ - hierarchy install installcheck installkernel installkernel.debug\ - reinstallkernel reinstallkernel.debug installworld \ - kernel-toolchain libraries lint maninstall \ + distribute distributeworld distrib-dirs distribution doxygen \ + everything hierarchy install installcheck installkernel \ + installkernel.debug reinstallkernel reinstallkernel.debug \ + installworld kernel-toolchain libraries lint maninstall \ obj objlink regress rerelease showconfig tags toolchain update \ _worldtmp _legacy _bootstrap-tools _cleanobj _obj \ _build-tools _cross-tools _includes _libraries _depend \ diff --git a/Makefile.inc1 b/Makefile.inc1 index 0a4d4f4aee9c..6e5bb1e6dff6 100644 --- a/Makefile.inc1 +++ b/Makefile.inc1 @@ -17,6 +17,7 @@ # The intended user-driven targets are: # buildworld - rebuild *everything*, including glue to help do upgrades # installworld- install everything built by "buildworld" +# doxygen - build API documentation of the kernel # update - convenient way to update your source tree (eg: cvsup/cvs) # # Standard targets (not defined here) are documented in the makefiles in @@ -710,6 +711,18 @@ reinstallkernel reinstallkernel.debug: installcheck ${CROSSENV} PATH=${TMPPATH} \ ${MAKE} KERNEL=${INSTKERNNAME} ${.TARGET:S/kernel//} +# +# doxygen +# +# Build the API documentation with doxygen +# +doxygen: + @if [ ! -x `/usr/bin/which doxygen` ]; then \ + echo "You need doxygen (devel/doxygen) to generate the API documentation of the kernel." | /usr/bin/fmt; \ + exit 1; \ + fi + cd ${.CURDIR}/sys/doc/subsys && ${MAKE} obj all + # # update #