From owner-freebsd-doc  Tue Apr 11  8: 3:21 2000
Delivered-To: freebsd-doc@freebsd.org
Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66])
	by hub.freebsd.org (Postfix) with ESMTP
	id 93FDF37B6C0; Tue, 11 Apr 2000 08:03:04 -0700 (PDT)
	(envelope-from nik@nothing-going-on.demon.co.uk)
Received: (from nik@localhost)
	by nothing-going-on.demon.co.uk (8.9.3/8.9.3) id PAA51878;
	Tue, 11 Apr 2000 15:53:14 +0100 (BST)
	(envelope-from nik)
Date: Tue, 11 Apr 2000 15:53:13 +0100
From: Nik Clayton <nik@freebsd.org>
To: Jeroen Ruigrok van der Werven <asmodai@bart.nl>
Cc: Nik Clayton <nik@FreeBSD.ORG>, doc@FreeBSD.ORG
Subject: Re: HEADS UP: Creating a "Developer's Handbook"
Message-ID: <20000411155313.A51267@catkin.nothing-going-on.org>
References: <20000406011457.C78379@catkin.nothing-going-on.org> <20000408220746.A57538@lucifer.bart.nl>
Mime-Version: 1.0
Content-Type: multipart/mixed; boundary="J2SCkAp4GZ/dPZZf"
X-Mailer: Mutt 1.0.1i
In-Reply-To: <20000408220746.A57538@lucifer.bart.nl>; from asmodai@bart.nl on Sat, Apr 08, 2000 at 10:07:46PM +0200
Organization: FreeBSD Project <URL:http://www.freebsd.org/>
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org


--J2SCkAp4GZ/dPZZf
Content-Type: text/plain; charset=us-ascii

Folks,

On Sat, Apr 08, 2000 at 10:07:46PM +0200, Jeroen Ruigrok van der Werven wrote:
> However on the Developer's note I already did some planning and
> organising, which can be found at
> http://home.wxs.nl/~asmodai/pdp/index.html

Attached is a rough and ready book.sgml.  Save it somewhere (/tmp ?), check
out the doc/ tree somewhere else, and then do:

    % cd doc/en*/books
    % cp -rp handbook developer-handbook
    % cd developer-handbook
    % cp /tmp/book.sgml .
    % make

add 'FORMATS=...' to the last line depending on your taste.

This uses the existing Handbook content for a few bits and pieces, and
puts together a sample structure for how the Developer Handbook might 
look.  I'll post a separate message in a minute with a URL for a pre-built
version of this for people to look at, and make comments on.  If we can
try and keep comments to that thread I'd be grateful.

N
-- 
Internet connection, $19.95 a month.  Computer, $799.95.  Modem, $149.95.
Telephone line, $24.95 a month.  Software, free.  USENET transmission,
hundreds if not thousands of dollars.  Thinking before posting, priceless.
Somethings in life you can't buy.  For everything else, there's MasterCard.
  -- Graham Reed, in the Scary Devil Monastery

--J2SCkAp4GZ/dPZZf
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="book.sgml"

<!--
     The FreeBSD Documentation Project

     $FreeBSD: doc/en_US.ISO_8859-1/books/handbook/book.sgml,v 1.89 2000/03/22 03:02:45 jim Exp $
-->

<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
%man;

<!ENTITY % bookinfo PUBLIC "-//FreeBSD//ENTITIES DocBook BookInfo Entities//EN">
%bookinfo;

<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters;
<!ENTITY % authors SYSTEM "authors.ent">  %authors;
<!ENTITY % mailing-lists SYSTEM "mailing-lists.ent"> %mailing-lists;
<!ENTITY % newsgroups SYSTEM "newsgroups.ent"> %newsgroups;
<!ENTITY % not.published "INCLUDE">

<!-- The currently released version of FreeBSD.  This value is used to
     create some links on web sites and such, so do NOT change it until
     it's really release time -->
<!ENTITY rel.current CDATA "4.0">
]>

<book>
  <bookinfo>
    <title>FreeBSD Developer Handbook</title>
    
    <authorgroup>
      <author>
	<surname>The FreeBSD Documentation Project</surname>
        <affiliation>
          <address>
            <email>doc@FreeBSD.org</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>
    
    <pubdate>April 2000</pubdate>
    
    <copyright>
      <year>2000</year>
      <holder>The FreeBSD Documentation Project</holder>
    </copyright>

    &bookinfo.legalnotice;
    
    <abstract>
      <para>The FreeBSD Developer Handbook covers the information you need to
	develop code for FreeBSD. This manual is a <emphasis>work in
	  progress</emphasis> and is the work of many individuals.  Many
	sections do not yet exist and some of those that do exist need to be
	updated.  If you are interested in helping with this project, send
	email to the &a.doc;.</para>
    </abstract>
  </bookinfo>

  <part>
    <title>Introduction</title>

    <chapter>
      <title>* Architectural Overview</title>
      
      <para></para>
    </chapter>

    &chap.boot;
    
    <chapter>
      <title>* The Kernel</title>
      
      <para></para>
    </chapter>
  </part>

  <part>
    <title>The Virtual Memory System</title>

    <chapter>
      <title>* Introduction</title>

      <para></para>
    </chapter>
  </part>

  <part>
    <title>Filesystems</title>

    <chapter>
      <title>* FFS</title>

      <para></para>
    </chapter>

    <chapter>
      <title>* NFS</title>

      <para></para>
    </chapter>

    <chapter>
      <title>* MFS</title>

      <para></para>
    </chapter>

    <chapter>
      <title>...</title>

      <para></para>
    </chapter>
  </part>

  <part>
    <title>Networking</title>

    <chapter>
      <title>* IPv4</title>

      <para></para>
    </chapter>

    <chapter>
      <title>* IPv6</title>

      <para></para>
    </chapter>

    <chapter>
      <title>...</title>

      <para></para>
    </chapter>
  </part>

  <part>
    <title>System Console</title>

    <chapter>
      <title>* Syscons</title>

      <para></para>
    </chapter>

    <chapter>
      <title>* PCVT</title>

      <para></para>
    </chapter>

    <chapter>
      <title>* Serial console</title>

      <para></para>
    </chapter>

    <chapter>
      <title>* Writing Screensavers</title>

      <para></para>
    </chapter>
  </part>

  <part>
    <title>Device Drivers</title>

    <chapter>
      <title>* Introduction</title>

      <para></para>
    </chapter>

    <chapter>
      <title>* Newbus</title>

      <para></para>
    </chapter>

    <chapter>
      <title>...</title>

      <para></para>
    </chapter>
  </part>

  <part>
    <title>Compatability layers</title>

    <chapter>
      <title>* Linux</title>

      <para></para>
    </chapter>

    <chapter>
      <title>SCO</title>

      <para></para>
    </chapter>
  </part>
  
  <part>
    <title>Debugging</title>

    &chap.kerneldebug;
    
    <chapter>
      <title>...</title>

      <para></para>
    </chapter>
  </part>
  
  <part>
    <title>Administrivia</title>

    &chap.policies;
  </part>
</book>

<!-- 
     Local Variables:
     mode: sgml
     sgml-indent-data: t
     sgml-omittag: nil
     sgml-always-quote-attributes: t
     End:
-->

--J2SCkAp4GZ/dPZZf--


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message