head	1.24;
access;
symbols
	RELEASE_8_3_0:1.24
	RELEASE_9_0_0:1.24
	RELEASE_7_4_0:1.24
	RELEASE_8_2_0:1.24
	RELEASE_8_1_0:1.24
	RELEASE_7_3_0:1.24
	RELEASE_8_0_0:1.24
	RELEASE_7_2_0:1.24
	RELEASE_7_1_0:1.24
	RELEASE_6_4_0:1.24
	RELEASE_6_3_0:1.23
	RELEASE_7_0_0:1.23
	RELEASE_6_2_0:1.23
	RELEASE_5_5_0:1.22
	RELEASE_6_1_0:1.22
	RELEASE_6_0_0:1.22
	RELEASE_5_4_0:1.22
	RELEASE_4_11_0:1.22
	RELEASE_5_3_0:1.22
	RELEASE_4_10_0:1.21
	RELEASE_5_2_1:1.20
	RELEASE_5_2_0:1.20
	RELEASE_4_9_0:1.20
	RELEASE_5_1_0:1.18
	RELEASE_4_8_0:1.15
	RELEASE_5_0_0:1.15
	RELEASE_4_7_0:1.15
	RELEASE_4_6_2:1.13
	RELEASE_4_6_1:1.13
	RELEASE_4_6_0:1.13
	RELEASE_4_5_0:1.11
	RELEASE_4_4_0:1.7
	old_RELEASE_4_3_0:1.1
	old_RELEASE_4_2_0:1.1;
locks; strict;
comment	@# @;


1.24
date	2008.08.10.00.20.27;	author pgj;	state Exp;
branches;
next	1.23;

1.23
date	2006.10.18.19.34.16;	author danger;	state Exp;
branches;
next	1.22;

1.22
date	2004.07.06.15.09.52;	author hrs;	state Exp;
branches;
next	1.21;

1.21
date	2004.02.15.22.56.09;	author simon;	state Exp;
branches;
next	1.20;

1.20
date	2003.08.12.05.05.40;	author murray;	state Exp;
branches;
next	1.19;

1.19
date	2003.08.06.23.47.59;	author simon;	state Exp;
branches;
next	1.18;

1.18
date	2003.04.22.18.35.41;	author hrs;	state Exp;
branches;
next	1.17;

1.17
date	2003.04.19.11.39.27;	author hrs;	state Exp;
branches;
next	1.16;

1.16
date	2003.04.11.09.21.14;	author blackend;	state Exp;
branches;
next	1.15;

1.15
date	2002.08.19.04.38.24;	author chris;	state Exp;
branches;
next	1.14;

1.14
date	2002.07.29.06.19.29;	author murray;	state Exp;
branches;
next	1.13;

1.13
date	2002.03.13.07.04.12;	author murray;	state Exp;
branches;
next	1.12;

1.12
date	2002.01.30.14.18.23;	author phantom;	state Exp;
branches;
next	1.11;

1.11
date	2001.11.23.19.01.25;	author murray;	state Exp;
branches;
next	1.10;

1.10
date	2001.11.19.06.11.14;	author murray;	state Exp;
branches;
next	1.9;

1.9
date	2001.10.17.08.53.34;	author murray;	state Exp;
branches;
next	1.8;

1.8
date	2001.09.13.00.15.54;	author chern;	state Exp;
branches;
next	1.7;

1.7
date	2001.07.19.22.06.05;	author murray;	state Exp;
branches;
next	1.6;

1.6
date	2001.06.23.04.57.31;	author murray;	state Exp;
branches;
next	1.5;

1.5
date	2001.06.22.08.49.10;	author murray;	state Exp;
branches;
next	1.4;

1.4
date	2001.05.14.02.52.41;	author murray;	state Exp;
branches;
next	1.3;

1.3
date	2001.05.11.10.27.00;	author murray;	state Exp;
branches;
next	1.2;

1.2
date	2001.05.02.01.53.13;	author murray;	state Exp;
branches;
next	1.1;

1.1
date	2000.07.30.18.20.23;	author asmodai;	state Exp;
branches;
next	;


desc
@@


1.24
log
@- Remove the chapter on DMA from FreeBSD Developers' Handbook since it
  is no longer valid, however there could be added a new chapter on
  busdma [1] instead of this one

[1] http://www.freebsd.org/projects/busdma/

PR:		docs/126146
Discussed with:	jhb
Submitted by:	gavin
Approved by:	gabor (mentor)
@
text
@# 
# $FreeBSD$
#
# Build the FreeBSD Developers' Handbook.
#

MAINTAINER=doc@@FreeBSD.org

DOC?= book

FORMATS?= html-split

HAS_INDEX= true

INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=

# Images
IMAGES_EN= sockets/layers.eps sockets/sain.eps sockets/sainfill.eps sockets/sainlsb.eps sockets/sainmsb.eps sockets/sainserv.eps sockets/serv.eps sockets/serv2.eps sockets/slayers.eps

# 
# SRCS lists the individual SGML files that make up the document. Changes
# to any of these files will force a rebuild
#

# SGML content
SRCS=  book.sgml
SRCS+= introduction/chapter.sgml
SRCS+= ipv6/chapter.sgml
SRCS+= kernelbuild/chapter.sgml
SRCS+= kerneldebug/chapter.sgml
SRCS+= l10n/chapter.sgml
SRCS+= policies/chapter.sgml
SRCS+= secure/chapter.sgml
SRCS+= sockets/chapter.sgml
SRCS+= testing/chapter.sgml
SRCS+= tools/chapter.sgml
SRCS+= x86/chapter.sgml

# Entities

URL_RELPREFIX?=	../../../..
DOC_PREFIX?=	${.CURDIR}/../../..

.include "${DOC_PREFIX}/share/mk/doc.project.mk"
@


1.23
log
@- remove useless chapter Makefile
- add kernelbuild/chapter.sgml to the main Makefile

Approved by: keramida (mentor)
@
text
@a27 1
SRCS+= dma/chapter.sgml
@


1.22
log
@Use relative URLs when URL_RELPREFIX is defined and URLS_ABSOLUTE
is not defined.

- URL_RELPREFIX must always point the top page's URL
  (http://www.FreeBSD.org) in relative form, defined in Makefile.

- &url.base; can be used in doc/<langcode>/*.  It will be
  replaced with the real URL which points the top page.

For translators: Please make sure to define URL_RELPREFIX to
point the top page.  The localized docs have different directory
hierarchy in its URL from the English version.

Tested by:	den
@
text
@d31 1
@


1.21
log
@Add a new chapter about "Regression and Performance Testing".

At the moment the main content is the Micro Benchmark Checklist posted
to -current by phk and expanded by rwatson.  The list did not really fit
in any of the current chapters, so a new chapter was created.  I hope
others can add more content to this chapter later.

Content by:	phk, rwatson
Reviewed by:	phk, josef
No objections:	-doc
@
text
@d42 3
a44 1
DOC_PREFIX?= ${.CURDIR}/../../..
@


1.20
log
@Relinquish maintainership to doc@@FreeBSD.org.
@
text
@d36 1
@


1.19
log
@o Split the FreeBSD Developers Handbook into two books:

  - FreeBSD Architecture Handbook, which is a book about the FreeBSD
    architecture.  The SMP article have also been moved into the new
    arch handbook as a separate chapter.

  - FreeBSD Developers Handbook, which is a book about developing on
    FreeBSD; basically what was left when the architecture parts was
    moved away.

o Hook up the new FreeBSD Architecture Handbook to the build.

o Remove the SMP article since it is now part of the FreeBSD
  Architecture Handbook.

The relevant files from the FreeBSD Developers Handbook have been
repository copied to the new FreeBSD Architecture Handbook.

This is just step one in the split, both books need some work to be
real seperate books.  E.g. the FreeBSD Architecture Handbook still
needs an introduction.

Repository copy by:	joe
Requested by:		rwatson
Approved by:		murray, ceri (mentor)
@
text
@d7 1
a7 1
MAINTAINER=murray@@FreeBSD.org
@


1.18
log
@Back out WITH_DOCFORMAT_NAVI_LINK?=YES in Makefile.  The navi-link
is generated when ${WITH_DOCFORMAT_NAVI_LINK} is defined or
${FORMATS} includes "html" and "html-split."
@
text
@a27 1
SRCS+= boot/chapter.sgml
a28 1
SRCS+= driverbasics/chapter.sgml
a30 2
SRCS+= isa/chapter.sgml
SRCS+= jail/chapter.sgml
a31 1
SRCS+= kobj/chapter.sgml
a32 3
SRCS+= locking/chapter.sgml
SRCS+= mac/chapter.sgml
SRCS+= pci/chapter.sgml
a33 1
SRCS+= scsi/chapter.sgml
a35 2
SRCS+= sound/chapter.sgml
SRCS+= sysinit/chapter.sgml
a36 2
SRCS+= usb/chapter.sgml
SRCS+= vm/chapter.sgml
@


1.17
log
@- Add WITH_DOCFORMAT_NAVI_LINK to mk/doc.docbook.mk and
  enable it in en_US.ISO8859-1/ and ja_JP.eucJP/.

- Add PUBLIC "-//FreeBSD//ENTITIES DocBook Language Specific Entities//EN"
  and l10n.ent for entity localization.

- Use share/misc/docbook.css for indentiation of <programlisting>
  and <screen>.

- Add some missing $FreeBSD$.
@
text
@a14 2
WITH_DOCFORMAT_NAVI_LINK?=YES

@


1.16
log
@Commit images separation from en_US.ISO8859-1/ directory to
share/images.  To link "generic" images (share/images ones) from
Makefiles use IMAGES_EN and to link localized images use IMAGES.
For an example look at en_US.ISO8859-1/books/handbook/Makefile
@
text
@d15 2
@


1.15
log
@Introduce support for Mandatory Access Control and extensible
kernel access control.

Document the kernel side of the MAC policy architecture.  This
is a little out of date at the moment.  Some parts to be filled
in as things are developed, and much is subject to change.  It
will, however, give developers a good idea of how things work.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
@
text
@d19 1
a19 1
IMAGES= sockets/layers.eps sockets/sain.eps sockets/sainfill.eps sockets/sainlsb.eps sockets/sainmsb.eps sockets/sainserv.eps sockets/serv.eps sockets/serv2.eps sockets/slayers.eps
@


1.14
log
@Remove the "History of the Unix Kernel" place-holder chapter.  That
material does not belong here.  Replace it with the new "Booting and
Kernel Initialization" chapter.
@
text
@d39 1
@


1.13
log
@Assume maintainership of the Developer's Handbook (was asmodai).  I
have by far made the most commits to this document, and I have some
ideas about splitting out the kernel content into a seperate book.
The scope of this document is too large.
@
text
@d28 1
@


1.12
log
@add missing chapters to SRCS. Sort SRCS while I'm here
@
text
@d7 1
a7 1
MAINTAINER=asmodai@@FreeBSD.org
@


1.11
log
@Add a chapter about writing device drivers for the sound subsystem.

Submitted by:	Jean-Francois Dockes <jean-francois.dockes@@wanadoo.fr>
Reviewed by:	cg
@
text
@d28 2
d31 5
a35 2
SRCS+= tools/chapter.sgml
SRCS+= secure/chapter.sgml
d37 2
d40 2
a41 1
SRCS+= locking/chapter.sgml
d43 3
a45 3
SRCS+= ipv6/chapter.sgml
SRCS+= isa/chapter.sgml
SRCS+= pci/chapter.sgml
d47 1
a47 1
SRCS+= scsi/chapter.sgml
a48 4
SRCS+= vm/chapter.sgml
SRCS+= dma/chapter.sgml
SRCS+= kerneldebug/chapter.sgml
SRCS+= sound/chapter.sgml
@


1.10
log
@Rework our index support.

  * Add a new document-specific variable, HAS_INDEX, to specify if a
    given document is marked up with <indexterm> entries.

  * Rework the index support so that both HAS_INDEX and GEN_INDEX are
    checked before trying to generate an index for a document.

  * Only create index.sgml if both HAS_INDEX and GEN_INDEX are set.

This allows us to recursively build the documentation tree with
GEN_INDEX=1 and have it only try to create an index (very time
consuming) for the few documents that are ready for this.  Previously,
running "make GEN_INDEX=1" from the top of the doc tree would look for
index terms in every single document.

With this, I hope we can start building our docs with GEN_INDEX set on
freefall so that users browsing the HTML docs will get the benefit of
the index we've been hiding in CVS for 6 months.
@
text
@d44 1
@


1.9
log
@Add the "Source Tree Guidelines and Policies" chapter by phk, obrien,
and others.  This was repo-copied from the Handbook.
@
text
@d13 2
a16 2

GEN_INDEX?= yes
@


1.8
log
@Add references to new chapter, l10n/Localization, to appropriate files.

Suggsted by: murray and nik
@
text
@d2 1
a2 1
# $FreeBSD: doc/en_US.ISO8859-1/books/developers-handbook/Makefile,v 1.7 2001/07/19 22:06:05 murray Exp $
d32 1
@


1.7
log
@Reorganize the Developer's Handbook.

  * Add chapter on kernel debugging (repo-copied from the Handbook)
  * Change "Introduction" part with 4 empty chapters to a
    "Introduction" chapter with 4 mostly empty <sect1>s.
  * Combine many of the different <part>s that contain only one empty
    <chapter> into larger <part>s.
  * Add * in front of unfinished chapter names so its very clear what
    needs to be worked on.
  * Added some <filename> tags where appropriate.
@
text
@d2 1
a2 1
# $FreeBSD: doc/en_US.ISO8859-1/books/developers-handbook/Makefile,v 1.6 2001/06/23 04:57:31 murray Exp $
d31 1
@


1.6
log
@Turn on our nascent index by default
@
text
@d2 1
a2 1
# $FreeBSD: doc/en_US.ISO8859-1/books/developers-handbook/Makefile,v 1.5 2001/06/22 08:49:10 murray Exp $
d28 1
d41 1
@


1.5
log
@Add a chapter on sockets programming.

Submitted by:	G. Adam Stanislav
@
text
@d2 1
a2 1
# $FreeBSD: doc/en_US.ISO8859-1/books/developers-handbook/Makefile,v 1.4 2001/05/14 02:52:41 murray Exp $
d15 2
@


1.4
log
@Add chapters on DMA Basics, IPv6 Implementation, and the VM systems.

Suggested by: 	nik
Obtained from:	The Handbook
@
text
@d2 1
a2 1
# $FreeBSD: doc/en_US.ISO_8859-1/books/developers-handbook/Makefile,v 1.3 2001/05/11 10:27:00 murray Exp $
d16 3
d29 2
a37 1
SRCS+= ipv6/chapter.sgml
@


1.3
log
@Oops, forgot to add SRCS+= x86/chapter.sgml.
@
text
@d2 1
a2 1
# $FreeBSD: doc/en_US.ISO_8859-1/books/developers-handbook/Makefile,v 1.2 2001/05/02 01:53:13 murray Exp $
d31 3
@


1.2
log
@Add Sergey Babkin's ISA device driver tutorial as a chapter to the
Developer's Handbook.

SGMLified by:	emacs, Wylie Stilwell, Valentino Vaschetto, and I
Approved by:	Sergey Babkin
Obtained from:	Daemonnews
@
text
@d2 1
a2 1
# $FreeBSD: doc/en_US.ISO_8859-1/books/developers-handbook/Makefile,v 1.1 2000/07/30 18:20:23 asmodai Exp $
d30 1
@


1.1
log
@Add the initial skeleton of the Developers' Handbook.
@
text
@d2 1
a2 1
# $FreeBSD$
d23 7
@

