Commit graph

27 commits

Author SHA1 Message Date
Isabell Long
2be1e25fc2 Replace 'SGML' with 'XML' in Makefile code and comments. A consequence of
this was that 'SGMLFLAGS' had to be changed to 'XMLFLAGS' in
share/mk/doc.docbook.mk so that everything continued to build OK.

Approved by:	gabor (mentor)
2012-10-06 17:52:37 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
2012-10-01 09:53:01 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces
Approved by:	doceng (implicit)
2012-08-21 19:16:02 +00:00
Gabor Pali
7b03a5b944 - 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)
2008-08-10 00:20:27 +00:00
Daniel Gerzo
908d7e6654 - remove useless chapter Makefile
- add kernelbuild/chapter.sgml to the main Makefile

Approved by: keramida (mentor)
2006-10-18 19:34:16 +00:00
Hiroki Sato
84f8ee0a15 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
2004-07-06 15:09:55 +00:00
Simon L. B. Nielsen
1b0e3a763d 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
2004-02-15 22:56:09 +00:00
Murray Stokely
90b93c73fd Relinquish maintainership to doc@FreeBSD.org. 2003-08-12 05:05:40 +00:00
Simon L. B. Nielsen
541f5ec33d 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)
2003-08-06 23:48:04 +00:00
Hiroki Sato
f6cd99b654 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."
2003-04-22 18:35:44 +00:00
Hiroki Sato
4f8b26641c - 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$.
2003-04-19 11:39:30 +00:00
Marc Fonvieille
47f6d4e260 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
2003-04-11 09:21:15 +00:00
Chris Costello
1c8ff53e4f 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
2002-08-19 04:38:25 +00:00
Murray Stokely
2c4941f92c 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.
2002-07-29 06:19:30 +00:00
Murray Stokely
536cf1f77b 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.
2002-03-13 07:04:12 +00:00
Alexey Zelkin
cea4821669 add missing chapters to SRCS. Sort SRCS while I'm here 2002-01-30 14:18:23 +00:00
Murray Stokely
7fe9c7b818 Add a chapter about writing device drivers for the sound subsystem.
Submitted by:	Jean-Francois Dockes <jean-francois.dockes@wanadoo.fr>
Reviewed by:	cg
2001-11-23 19:01:25 +00:00
Murray Stokely
0361e0a8d3 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.
2001-11-19 06:11:16 +00:00
Murray Stokely
aea326884e Add the "Source Tree Guidelines and Policies" chapter by phk, obrien,
and others.  This was repo-copied from the Handbook.
2001-10-17 08:53:34 +00:00
Chern Lee
ca986fc704 Add references to new chapter, l10n/Localization, to appropriate files.
Suggsted by: murray and nik
2001-09-13 00:15:54 +00:00
Murray Stokely
d78ef2bfe3 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.
2001-07-19 22:06:06 +00:00
Murray Stokely
2cf4943a03 Turn on our nascent index by default 2001-06-23 04:57:32 +00:00
Murray Stokely
33c100c32d Add a chapter on sockets programming.
Submitted by:	G. Adam Stanislav
2001-06-22 08:49:14 +00:00
Murray Stokely
90b1aec3d1 Add chapters on DMA Basics, IPv6 Implementation, and the VM systems.
Suggested by: 	nik
Obtained from:	The Handbook
2001-05-14 02:52:44 +00:00
Murray Stokely
e2ee892e4b Oops, forgot to add SRCS+= x86/chapter.sgml. 2001-05-11 10:27:00 +00:00
Murray Stokely
0fb2e7255d 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
2001-05-02 01:53:14 +00:00
Jeroen Ruigrok van der Werven
e39773fe6a Add the initial skeleton of the Developers' Handbook. 2000-07-30 18:20:23 +00:00