head	1.3;
access;
symbols
	RELENG_8_4:1.3.0.2
	RELENG_9_1_0_RELEASE:1.2.16.1.4.2
	RELENG_9_1:1.2.16.1.0.4
	RELENG_9_1_BP:1.2.16.1
	RELENG_8_3_0_RELEASE:1.2.10.1.8.1
	RELENG_8_3:1.2.10.1.0.8
	RELENG_8_3_BP:1.2.10.1
	RELENG_9_0_0_RELEASE:1.2.16.1.2.1
	RELENG_9_0:1.2.16.1.0.2
	RELENG_9_0_BP:1.2.16.1
	RELENG_9:1.2.0.16
	RELENG_9_BP:1.2
	RELENG_7_4_0_RELEASE:1.2.14.1
	RELENG_8_2_0_RELEASE:1.2.10.1.6.1
	RELENG_7_4:1.2.0.14
	RELENG_7_4_BP:1.2
	RELENG_8_2:1.2.10.1.0.6
	RELENG_8_2_BP:1.2.10.1
	RELENG_8_1_0_RELEASE:1.2.10.1.4.1
	RELENG_8_1:1.2.10.1.0.4
	RELENG_8_1_BP:1.2.10.1
	RELENG_7_3_0_RELEASE:1.2.12.1
	RELENG_7_3:1.2.0.12
	RELENG_7_3_BP:1.2
	RELENG_8_0_0_RELEASE:1.2.10.1.2.1
	RELENG_8_0:1.2.10.1.0.2
	RELENG_8_0_BP:1.2.10.1
	RELENG_8:1.2.0.10
	RELENG_8_BP:1.2
	RELENG_7_2_0_RELEASE:1.2.8.1
	RELENG_7_2:1.2.0.8
	RELENG_7_2_BP:1.2
	RELENG_7_1_0_RELEASE:1.2.6.1
	RELENG_7_1:1.2.0.6
	RELENG_7_1_BP:1.2
	RELENG_7_0_0_RELEASE:1.2
	RELENG_7_0:1.2.0.4
	RELENG_7_0_BP:1.2
	RELENG_7:1.2.0.2
	RELENG_7_BP:1.2;
locks; strict;
comment	@# @;


1.3
date	2012.11.17.01.53.41;	author svnexp;	state Exp;
branches
	1.3.2.1;
next	1.2;

1.2
date	2006.07.08.12.31.33;	author netchild;	state Exp;
branches
	1.2.2.1
	1.2.6.1
	1.2.8.1
	1.2.10.1
	1.2.12.1
	1.2.14.1
	1.2.16.1;
next	1.1;

1.1
date	2006.05.26.18.06.07;	author netchild;	state Exp;
branches;
next	;

1.3.2.1
date	2012.11.17.01.53.41;	author svnexp;	state dead;
branches;
next	1.3.2.2;

1.3.2.2
date	2013.03.28.13.05.47;	author svnexp;	state Exp;
branches;
next	;

1.2.2.1
date	2012.11.17.08.07.53;	author svnexp;	state Exp;
branches;
next	;

1.2.6.1
date	2008.11.25.02.59.29;	author kensmith;	state Exp;
branches;
next	;

1.2.8.1
date	2009.04.15.03.14.26;	author kensmith;	state Exp;
branches;
next	;

1.2.10.1
date	2009.08.03.08.13.06;	author kensmith;	state Exp;
branches
	1.2.10.1.2.1
	1.2.10.1.4.1
	1.2.10.1.6.1
	1.2.10.1.8.1;
next	1.2.10.2;

1.2.10.2
date	2012.11.17.10.37.09;	author svnexp;	state Exp;
branches;
next	;

1.2.10.1.2.1
date	2009.10.25.01.10.29;	author kensmith;	state Exp;
branches;
next	;

1.2.10.1.4.1
date	2010.06.14.02.09.06;	author kensmith;	state Exp;
branches;
next	;

1.2.10.1.6.1
date	2010.12.21.17.09.25;	author kensmith;	state Exp;
branches;
next	;

1.2.10.1.8.1
date	2012.03.03.06.15.13;	author kensmith;	state Exp;
branches;
next	1.2.10.1.8.2;

1.2.10.1.8.2
date	2012.11.17.08.25.43;	author svnexp;	state Exp;
branches;
next	;

1.2.12.1
date	2010.02.10.00.26.20;	author kensmith;	state Exp;
branches;
next	;

1.2.14.1
date	2010.12.21.17.10.29;	author kensmith;	state Exp;
branches;
next	1.2.14.2;

1.2.14.2
date	2012.11.17.08.17.37;	author svnexp;	state Exp;
branches;
next	;

1.2.16.1
date	2011.09.23.00.51.37;	author kensmith;	state Exp;
branches
	1.2.16.1.2.1
	1.2.16.1.4.1;
next	1.2.16.2;

1.2.16.2
date	2012.11.17.11.37.28;	author svnexp;	state Exp;
branches;
next	;

1.2.16.1.2.1
date	2011.11.11.04.20.22;	author kensmith;	state Exp;
branches;
next	1.2.16.1.2.2;

1.2.16.1.2.2
date	2012.11.17.08.37.24;	author svnexp;	state Exp;
branches;
next	;

1.2.16.1.4.1
date	2012.08.05.23.54.33;	author kensmith;	state Exp;
branches;
next	1.2.16.1.4.2;

1.2.16.1.4.2
date	2012.11.17.08.48.15;	author svnexp;	state Exp;
branches;
next	;


desc
@@


1.3
log
@Switching exporter and resync
@
text
@       The kernel subsystem API documentation generation framework.
      --------------------------------------------------------------

For every Doxyfile-(.*) the Makefile adds the public targets $1, pdf-$1 and
clean-$1. For e.g. Doxyfile-dev_pci this translates to the targets dev_pci,
pdf-dev_pci and clean-dev_pci.

Additionally, the targets 'all', 'pdf-all' and 'clean' to generate or remove
the documentation for all targets are available.

The file 'Dependencies' contains dependencies for the .tag files.

To add another part to the documentation just copy a Doxyfile and add
the necessary dependencies to the file 'Dependencies'.

The following environment variables can be used in the Doxyfile:
 - DOXYGEN_SRC_PATH		(/usr/src/sys)
 - DOXYGEN_DEST_PATH		(where the docs are generated)
 - DOXYGEN_TARGET_ARCH		(${TARGET_ARCH} if set, else ${MACHINE_ARCH})

For the PDF generation you may have to change some limits in the latex
configuration (the build may fail and an error about e.g. "pool size" is
shown), for print/teTeX this is done in
	/usr/local/share/texmf/web2c/texmf.cnf

Programs needed to generate the API docs:
 - devel/doxygen
 - print/teTeX
 - graphics/graphviz

-- 
$FreeBSD: head/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.3.2.1
log
@file README was added on branch RELENG_8_4 on 2013-03-28 13:05:47 +0000
@
text
@d1 32
@


1.3.2.2
log
@## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/248810
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
@
text
@a0 32
       The kernel subsystem API documentation generation framework.
      --------------------------------------------------------------

For every Doxyfile-(.*) the Makefile adds the public targets $1, pdf-$1 and
clean-$1. For e.g. Doxyfile-dev_pci this translates to the targets dev_pci,
pdf-dev_pci and clean-dev_pci.

Additionally, the targets 'all', 'pdf-all' and 'clean' to generate or remove
the documentation for all targets are available.

The file 'Dependencies' contains dependencies for the .tag files.

To add another part to the documentation just copy a Doxyfile and add
the necessary dependencies to the file 'Dependencies'.

The following environment variables can be used in the Doxyfile:
 - DOXYGEN_SRC_PATH		(/usr/src/sys)
 - DOXYGEN_DEST_PATH		(where the docs are generated)
 - DOXYGEN_TARGET_ARCH		(${TARGET_ARCH} if set, else ${MACHINE_ARCH})

For the PDF generation you may have to change some limits in the latex
configuration (the build may fail and an error about e.g. "pool size" is
shown), for print/teTeX this is done in
	/usr/local/share/texmf/web2c/texmf.cnf

Programs needed to generate the API docs:
 - devel/doxygen
 - print/teTeX
 - graphics/graphviz

-- 
$FreeBSD: releng/8.4/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2
log
@Forced commit to note repo copy from sys/doc.

Requested by:	trhodes
Repo copy by:	simon
@
text
@d32 1
a32 1
$FreeBSD$
@


1.2.2.1
log
@Switch importer
@
text
@d32 1
a32 1
$FreeBSD: stable/7/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2.16.1
log
@SVN rev 225736 on 2011-09-23 00:51:37Z by kensmith

Copy head to stable/9 as part of 9.0-RELEASE release cycle.

Approved by:	re (implicit)
@
text
@@


1.2.16.2
log
@## SVN ##
## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/ 242902
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
## SVN ##
## SVN ## ------------------------------------------------------------------------
## SVN ## r242902 | dteske | 2012-11-11 23:29:45 +0000 (Sun, 11 Nov 2012) | 10 lines
## SVN ##
## SVN ## Fix a regression introduced by SVN r211417 that saw the breakage of a feature
## SVN ## documented in usr.sbin/sysinstall/help/shortcuts.hlp (reproduced below):
## SVN ##
## SVN ## If /usr/sbin/sysinstall is linked to another filename, say
## SVN ## `/usr/local/bin/configPackages', then the basename will be used
## SVN ## as an implicit command name.
## SVN ##
## SVN ## Reviewed by:	adrian (co-mentor)
## SVN ## Approved by:	adrian (co-mentor)
## SVN ##
## SVN ## ------------------------------------------------------------------------
## SVN ##
@
text
@d32 1
a32 1
$FreeBSD: stable/9/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2.16.1.4.1
log
@SVN rev 239080 on 2012-08-05 23:54:33Z by kensmith

Copy stable/9 to releng/9.1 as part of the 9.1-RELEASE release process.

Approved by:	re (implicit)
@
text
@@


1.2.16.1.4.2
log
@Switch importer
@
text
@d32 1
a32 1
$FreeBSD: releng/9.1/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2.16.1.2.1
log
@SVN rev 227445 on 2011-11-11 04:20:22Z by kensmith

Copy stable/9 to releng/9.0 as part of the FreeBSD 9.0-RELEASE release
cycle.

Approved by:	re (implicit)
@
text
@@


1.2.16.1.2.2
log
@Switch importer
@
text
@d32 1
a32 1
$FreeBSD: releng/9.0/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2.14.1
log
@SVN rev 216618 on 2010-12-21 17:10:29Z by kensmith

Copy stable/7 to releng/7.4 in preparation for FreeBSD-7.4 release.

Approved by:	re (implicit)
@
text
@@


1.2.14.2
log
@Switch importer
@
text
@d32 1
a32 1
$FreeBSD: releng/7.4/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2.12.1
log
@SVN rev 203736 on 2010-02-10 00:26:20Z by kensmith

Copy stable/7 to releng/7.3 as part of the 7.3-RELEASE process.

Approved by:	re (implicit)
@
text
@@


1.2.10.1
log
@SVN rev 196045 on 2009-08-03 08:13:06Z by kensmith

Copy head to stable/8 as part of 8.0 Release cycle.

Approved by:	re (Implicit)
@
text
@@


1.2.10.2
log
@## SVN ##
## SVN ## Exported commit - http://svnweb.freebsd.org/changeset/base/ 242909
## SVN ## CVS IS DEPRECATED: http://wiki.freebsd.org/CvsIsDeprecated
## SVN ##
## SVN ## ------------------------------------------------------------------------
## SVN ## r242909 | dim | 2012-11-12 07:47:19 +0000 (Mon, 12 Nov 2012) | 20 lines
## SVN ##
## SVN ## MFC r242625:
## SVN ##
## SVN ## Remove duplicate const specifiers in many drivers (I hope I got all of
## SVN ## them, please let me know if not).  Most of these are of the form:
## SVN ##
## SVN ## static const struct bzzt_type {
## SVN ##       [...list of members...]
## SVN ## } const bzzt_devs[] = {
## SVN ##       [...list of initializers...]
## SVN ## };
## SVN ##
## SVN ## The second const is unnecessary, as arrays cannot be modified anyway,
## SVN ## and if the elements are const, the whole thing is const automatically
## SVN ## (e.g. it is placed in .rodata).
## SVN ##
## SVN ## I have verified this does not change the binary output of a full kernel
## SVN ## build (except for build timestamps embedded in the object files).
## SVN ##
## SVN ## Reviewed by:	yongari, marius
## SVN ##
## SVN ## ------------------------------------------------------------------------
## SVN ##
@
text
@d32 1
a32 1
$FreeBSD: stable/8/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2.10.1.8.1
log
@SVN rev 232438 on 2012-03-03 06:15:13Z by kensmith

Copy stable/8 to releng/8.3 as part of 8.3-RELEASE release cycle.

Approved by:	re (implicit)
@
text
@@


1.2.10.1.8.2
log
@Switch importer
@
text
@d32 1
a32 1
$FreeBSD: releng/8.3/tools/kerneldoc/subsys/README 160171 2006-07-08 12:31:33Z netchild $
@


1.2.10.1.6.1
log
@SVN rev 216617 on 2010-12-21 17:09:25Z by kensmith

Copy stable/8 to releng/8.2 in preparation for FreeBSD-8.2 release.

Approved by:	re (implicit)
@
text
@@


1.2.10.1.4.1
log
@SVN rev 209145 on 2010-06-14 02:09:06Z by kensmith

Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.

Approved by:	re (implicit)
@
text
@@


1.2.10.1.2.1
log
@SVN rev 198460 on 2009-10-25 01:10:29Z by kensmith

Copy stable/8 to releng/8.0 as part of 8.0-RELEASE release procedure.

Approved by:	re (implicit)
@
text
@@


1.2.8.1
log
@SVN rev 191087 on 2009-04-15 03:14:26Z by kensmith

Create releng/7.2 from stable/7 in preparation for 7.2-RELEASE.

Approved by:	re (implicit)
@
text
@@


1.2.6.1
log
@SVN rev 185281 on 2008-11-25 02:59:29Z by kensmith

Create releng/7.1 in preparation for moving into RC phase of 7.1 release
cycle.

Approved by:	re (implicit)
@
text
@@


1.1
log
@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
@
text
@@

