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
This commit is contained in:
Alexander Leidinger 2006-05-26 18:10:06 +00:00
parent ff4b8cb7bd
commit becc5c626d
2 changed files with 18 additions and 4 deletions

View File

@ -15,6 +15,7 @@
# reinstallkernel - Reinstall the kernel and the kernel-modules. # reinstallkernel - Reinstall the kernel and the kernel-modules.
# reinstallkernel.debug # reinstallkernel.debug
# kernel - buildkernel + installkernel. # kernel - buildkernel + installkernel.
# doxygen - Build API documentation of the kernel, needs doxygen.
# update - Convenient way to update your source tree (cvs). # update - Convenient way to update your source tree (cvs).
# check-old - Print a list of old files/directories in the system. # check-old - Print a list of old files/directories in the system.
# delete-old - Delete obsolete files and directories interactively. # delete-old - Delete obsolete files and directories interactively.
@ -69,10 +70,10 @@
# #
TGTS= all all-man buildenv buildkernel buildworld check-old checkdpadd \ TGTS= all all-man buildenv buildkernel buildworld check-old checkdpadd \
clean cleandepend cleandir delete-old delete-old-libs depend \ clean cleandepend cleandir delete-old delete-old-libs depend \
distribute distributeworld distrib-dirs distribution everything \ distribute distributeworld distrib-dirs distribution doxygen \
hierarchy install installcheck installkernel installkernel.debug\ everything hierarchy install installcheck installkernel \
reinstallkernel reinstallkernel.debug installworld \ installkernel.debug reinstallkernel reinstallkernel.debug \
kernel-toolchain libraries lint maninstall \ installworld kernel-toolchain libraries lint maninstall \
obj objlink regress rerelease showconfig tags toolchain update \ obj objlink regress rerelease showconfig tags toolchain update \
_worldtmp _legacy _bootstrap-tools _cleanobj _obj \ _worldtmp _legacy _bootstrap-tools _cleanobj _obj \
_build-tools _cross-tools _includes _libraries _depend \ _build-tools _cross-tools _includes _libraries _depend \

View File

@ -17,6 +17,7 @@
# The intended user-driven targets are: # The intended user-driven targets are:
# buildworld - rebuild *everything*, including glue to help do upgrades # buildworld - rebuild *everything*, including glue to help do upgrades
# installworld- install everything built by "buildworld" # installworld- install everything built by "buildworld"
# doxygen - build API documentation of the kernel
# update - convenient way to update your source tree (eg: cvsup/cvs) # update - convenient way to update your source tree (eg: cvsup/cvs)
# #
# Standard targets (not defined here) are documented in the makefiles in # Standard targets (not defined here) are documented in the makefiles in
@ -710,6 +711,18 @@ reinstallkernel reinstallkernel.debug: installcheck
${CROSSENV} PATH=${TMPPATH} \ ${CROSSENV} PATH=${TMPPATH} \
${MAKE} KERNEL=${INSTKERNNAME} ${.TARGET:S/kernel//} ${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 # update
# #