Commit graph

10 commits

Author SHA1 Message Date
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