Skip to content

Commit f28c155

Browse files
committed
kerneldoc: update target name and requirement checks
The target name `doxygen` is not clear as it doesn't show how its purpose. Replacing it with a new target name `kerneldoc` seems to be clearer. Signed-off-by: Minsoo Choo <[email protected]>
1 parent a25cfca commit f28c155

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
# kernel - buildkernel + installkernel.
2323
# kernel-toolchain - Builds the subset of world necessary to build a kernel
2424
# kernel-toolchains - Build kernel-toolchain for all universe targets.
25-
# doxygen - Build API documentation of the kernel, needs doxygen.
25+
# kerneldoc - Build API documentation of the kernel, needs doxygen, teTeX, and graphviz.
2626
# checkworld - Run test suite on installed world.
2727
# check-old - List obsolete directories/files/libraries.
2828
# check-old-dirs - List obsolete directories.
@@ -159,9 +159,9 @@ TGTS= all all-man buildenv buildenvvars buildetc buildkernel buildworld \
159159
cleanworld cleanuniverse \
160160
delete-old delete-old-dirs delete-old-files delete-old-libs \
161161
depend distribute distributekernel distributekernel.debug \
162-
distributeworld distrib-dirs distribution doxygen \
162+
distributeworld distrib-dirs distribution \
163163
everything hier hierarchy install installcheck installetc installkernel \
164-
installkernel.debug packagekernel packageworld \
164+
installkernel.debug kerneldoc packagekernel packageworld \
165165
reinstallkernel reinstallkernel.debug \
166166
installworld kernel-toolchain libraries maninstall \
167167
list-old-dirs list-old-files list-old-libs \
@@ -801,7 +801,7 @@ universe_epilogue: .PHONY
801801
.MAKE.MODE= normal
802802
# Normally the things we run from here don't either.
803803
# Using -DWITH_META_MODE
804-
# we can buildworld with meta files created which are useful
804+
# we can buildworld with meta files created which are useful
805805
# for debugging, but without any of the rest of a meta mode build.
806806
MK_DIRDEPS_BUILD= no
807807
MK_STAGING= no

Makefile.inc1

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@
3838

3939
#
4040
# The intended user-driven targets are:
41-
# buildworld - rebuild *everything*, including glue to help do upgrades
42-
# installworld- install everything built by "buildworld"
43-
# checkworld - run test suite on installed world
44-
# doxygen - build API documentation of the kernel
41+
# buildworld - rebuild *everything*, including glue to help do upgrades
42+
# installworld - install everything built by "buildworld"
43+
# checkworld - run test suite on installed world
44+
# kerneldoc - build API documentation of the kernel
4545
#
4646
# Standard targets (not defined here) are documented in the makefiles in
4747
# /usr/share/mk. These include:
@@ -2378,15 +2378,23 @@ checkworld: .PHONY
23782378

23792379
#
23802380
#
2381-
# doxygen
2381+
# kerneldoc
23822382
#
23832383
# Build the API documentation with doxygen
23842384
#
2385-
doxygen: .PHONY
2385+
kerneldoc: .PHONY
23862386
@if [ ! -x "${LOCALBASE}/bin/doxygen" ]; then \
23872387
echo "You need doxygen (devel/doxygen) to generate the API documentation of the kernel." | /usr/bin/fmt; \
23882388
exit 1; \
23892389
fi
2390+
@if [ ! -x "${LOCALBASE}/bin/tex" ]; then \
2391+
echo "You need teTeX (print/teTeX) to generate the API documentation of the kernel." | /usr/bin/fmt; \
2392+
exit 1; \
2393+
fi
2394+
@if [ ! -x "${LOCALBASE}/bin/dot" ]; then \
2395+
echo "You need graphviz (graphics/graphviz) to generate the API documentation of the kernel." | /usr/bin/fmt; \
2396+
exit 1; \
2397+
fi
23902398
${_+_}cd ${.CURDIR}/tools/kerneldoc/subsys; ${MAKE} obj all
23912399

23922400
#

0 commit comments

Comments
 (0)