freebsd with flexible iflib nic queues
Go to file
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
bin Fix the wording about the blocksize (-b) parameter. The existing 2006-05-10 20:32:57 +00:00
contrib Resolve conflicts. 2006-05-21 15:52:24 +00:00
crypto Introduce a namespace munging hack inspired by NetBSD to avoid polluting 2006-05-13 13:47:45 +00:00
etc Quote the parameter to sysctl(1), allowing to use whitespaces in 2006-05-24 11:36:48 +00:00
games In our system there's no intermediate step between a definitive Supreme 2006-05-25 11:21:40 +00:00
gnu Clean the product of patch(1). 2006-04-10 09:00:19 +00:00
include Add size_t declaration 2006-05-22 05:57:39 +00:00
kerberos5 Bump library majro version for gethostbyaddr(3). 2006-05-21 15:15:21 +00:00
lib - Add include for libutil.h and string.h for prototype. 2006-05-25 04:01:04 +00:00
libexec *thwack*! all the world's not i386. 2006-03-29 12:29:01 +00:00
release New release notes: ipfwpcap(8), jemalloc. 2006-05-22 20:18:04 +00:00
rescue Pass -DCRUNCH down to standard targets in individual makefiles. 2006-04-10 09:32:50 +00:00
sbin Implement internal (i.e. inside kernel) packet tagging using mbuf_tags(9). 2006-05-24 13:09:55 +00:00
secure Add a manual dependency on ssh_namespace.h. 2006-05-13 21:38:16 +00:00
share s/2005/2006/ for FreeBSD 6.1 and 5.5. 2006-05-26 13:19:46 +00:00
sys This is the kernel subsystem API documentation generation framework. 2006-05-26 18:06:07 +00:00
tools This is the kernel subsystem API documentation generation framework. 2006-05-26 18:06:07 +00:00
usr.bin Enable numeric arguments and +/- prefixes with -user (-group) 2006-05-25 21:20:43 +00:00
usr.sbin Ignore SIGPIPE signals on write() failures. 2006-05-25 22:12:05 +00:00
COPYRIGHT Happy new year, a little late 2006-01-15 22:06:10 +00:00
LOCKS Document commit constraints for RELENG_6_*. 2006-01-13 06:51:43 +00:00
MAINTAINERS Vinod has passed the maintainership for the twa/twe drivers to 2006-05-24 16:01:34 +00:00
Makefile Disconnect Alpha from 'make universe'. 2006-05-11 18:54:16 +00:00
Makefile.inc1 Send the pcvt(4) driver off to retirement. 2006-05-17 09:33:15 +00:00
ObsoleteFiles.inc Belatedly add usr/share/man/man4.sab.4.gz. The sab(4) driver was 2006-05-20 00:30:06 +00:00
README Add a note explaining what the rescue/ directory is for. 2006-03-01 20:14:55 +00:00
UPDATING Note that an old adjkerntz is not really usable after the recent 2006-05-15 15:47:45 +00:00

This is the top level of the FreeBSD source directory.  This file
was last revised on:
$FreeBSD$

For copyright information, please see the file COPYRIGHT in this
directory (additional copyright information also exists for some
sources in this tree - please see the specific source directories for
more information).

The Makefile in this directory supports a number of targets for
building components (or all) of the FreeBSD source tree, the most
commonly used one being ``world'', which rebuilds and installs
everything in the FreeBSD system from the source tree except the
kernel, the kernel-modules and the contents of /etc.  The
``buildkernel'' and ``installkernel'' targets build and install
the kernel and the modules (see below).  Please see the top of
the Makefile in this directory for more information on the
standard build targets and compile-time flags.

Building a kernel is a somewhat more involved process, documentation
for which can be found at:
   http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
And in the config(8) man page.
Note: If you want to build and install the kernel with the
``buildkernel'' and ``installkernel'' targets, you might need to build
world before.  More information is available in the handbook.

The sample kernel configuration files reside in the sys/<arch>/conf
sub-directory (assuming that you've installed the kernel sources), the
file named GENERIC being the one used to build your initial installation
kernel.  The file NOTES contains entries and documentation for all possible
devices, not just those commonly used.  It is the successor of the ancient
LINT file, but in contrast to LINT, it is not buildable as a kernel but a
pure reference and documentation file.


Source Roadmap:
---------------
bin		System/user commands.

contrib		Packages contributed by 3rd parties.

crypto		Cryptography stuff (see crypto/README).

etc		Template files for /etc.

games		Amusements.

gnu		Various commands and libraries under the GNU Public License.
		Please see gnu/COPYING* for more information.

include		System include files.

kerberos5	Kerberos5 (Heimdal) package.

lib		System libraries.

libexec		System daemons.

release		Release building Makefile & associated tools.

rescue		Build system for statically linked /rescue utilities.

sbin		System commands.

secure		Cryptographic libraries and commands.

share		Shared resources.

sys		Kernel sources.

tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.


For information on synchronizing your source tree with one or more of
the FreeBSD Project's development branches, please see:

  http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/synching.html