freebsd-skq

History

Alexander Leidinger ff4b8cb7bd This is the kernel subsystem API documentation generation framework. It uses doxygen to generate the API documentation. For each subsystem a very small (about 20 lines with comments) subsystem specific Doxyfile has to be written (have a look at the README for more). All common doxygen options are specified in a separate file. The framework is configured to not only generate the HTML version, but also a PDF version (the paper size is hardcoded to DIN A4 currently and depending on the subsystem you have to increase some limits in the latex configuration of your system, the README tells more about this). It also allows cross-references between the subsystems (it generates doxygen tag files). Currently the docs are generated in OBJDIR, but this may change after coordination with doc@. The makefile is prepared to generate/move various parts of the generated docs to different destinations. TARGET_ARCH is respected and some env-vars are set for architecture specific handling of the source (the README tells more). Subsystems for which docs are generated: - cam - crypto - dev_pci - dev_sound - dev_usb - geom - i4b - kern - libkern - linux - net80211 - netgraph - netinet - netinet6 - netipsec - opencrypto - vm Requested by: gnn		2006-05-26 18:06:07 +00:00
..
build	Switch value back to values.	2006-05-20 04:32:10 +00:00
debugscripts	o Correct comments: remove a reference to non-existent gdbinit.9 man page;	2006-05-22 07:12:25 +00:00
diag	Start the dreaded NOFOO -> NO_FOO conversion.	2004-12-21 08:47:35 +00:00
kerneldoc	This is the kernel subsystem API documentation generation framework.	2006-05-26 18:06:07 +00:00
KSE	Start the dreaded NOFOO -> NO_FOO conversion.	2004-12-21 08:47:35 +00:00
LibraryReport
regression	Use WARNS and rely on rules rather than an explicit target for the	2006-05-25 10:46:43 +00:00
sched	Teach schedgraph how to parse KTR_CRITICAL records. critical_enter/exit	2005-11-21 21:27:40 +00:00
test	Start the dreaded NOFOO -> NO_FOO conversion.	2004-12-21 08:47:35 +00:00
tools	make cryptotest compile after the latest changes to cryptodev.h	2006-05-24 15:40:46 +00:00
install.sh	Arguments to options aren't necessarily separated with whitespace.	2004-07-07 09:38:14 +00:00
make_libdeps.sh	Send the pcvt(4) driver off to retirement.	2006-05-17 09:33:15 +00:00
README

README

$FreeBSD$

This directory tree contains tools used for the maintenance and
testing of FreeBSD.  There is no toplevel Makefile structure since
these tools are not meant to be built as part of the standard system,
though there may be individual Makefiles in some of the subdirs.

Please read the README files in the subdirs for further information.