Add the initial skeleton of the Developers' Handbook.

This commit is contained in:
Jeroen Ruigrok van der Werven 2000-07-30 18:20:23 +00:00
parent 5ce2d8f306
commit e39773fe6a
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=7755
6 changed files with 777 additions and 0 deletions
en_US.ISO8859-1/books
arch-handbook
developers-handbook
en_US.ISO_8859-1/books/developers-handbook

View file

@ -0,0 +1,27 @@
#
# $FreeBSD$
#
# Build the FreeBSD Developers' Handbook.
#
MAINTAINER=asmodai@FreeBSD.org
DOC?= book
FORMATS?= html-split
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
#
# 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
# Entities
DOC_PREFIX?= ${.CURDIR}/../../..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

View file

@ -0,0 +1,232 @@
<!--
The FreeBSD Documentation Project
$FreeBSD$
-->
<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
<!ENTITY % bookinfo PUBLIC "-//FreeBSD//ENTITIES DocBook BookInfo Entities//EN">
%bookinfo;
]>
<book>
<bookinfo>
<title>FreeBSD Developers' Handbook</title>
<authorgroup>
<author>
<surname>The FreeBSD Documentation Project</surname>
<affiliation>
<address>
<email>doc@FreeBSD.org</email>
</address>
</affiliation>
</author>
</authorgroup>
<pubdate>August 2000</pubdate>
<copyright>
<year>2000</year>
<holder>The FreeBSD Documentation Project</holder>
</copyright>
&bookinfo.legalnotice;
<abstract>
<para>Welcome to the Developers' Handbook.</para>
</abstract>
</bookinfo>
<part id="introduction">
<title>Introduction</title>
<chapter id="developmentplatform">
<title>Developing on FreeBSD</title>
<para>This will need to discuss FreeBSD as a development
platform, the vision of BSD, architectural overview, layout of
/usr/src, history, etc.</para>
<para>Thank you for considering FreeBSD as your development
platform! We hope it will not let you down.</para>
</chapter>
<chapter id="bsdvision">
<title>The BSD Vision</title>
<para></para>
</chapter>
<chapter id="archoverview">
<title>Architectural Overview</title>
<para></para>
</chapter>
<chapter id="sourcelayout">
<title>The Layout of /usr/src</title>
<para></para>
</chapter>
</part>
<part id="Basics">
<title>Basics</title>
<chapter id="compilation">
<title>Compilation</title>
<para>This will include things like: compilation, makefiles, .mk
files, basic debugging, linking, secure programming
guidelines, style(9), CVS, diff, patch, etc.</para>
<para></para>
</chapter>
</part>
<part id="kernel">
<title>Kernel</title>
<chapter id="kernelhistory">
<title>History of the Unix Kernel</title>
<para>Some history of the Unix/BSD kernel, system calls, how do
processes work, blocking, scheduling, threads (kernel),
context switching, signals, interrupts, modules, etc.</para>
<para></para>
</chapter>
</part>
<part id="memory">
<title>Memory and Virtual Memory</title>
<chapter id="virtualmemory">
<title>Virtual Memory</title>
<para>VM, paging, swapping, allocating memory, testing for
memory leaks, mmap, vnodes, etc.</para>
<para></para>
</chapter>
</part>
<part id="iosystem">
<title>I/O System</title>
<chapter id="ufs">
<title>UFS</title>
<para>UFS, FFS, Ext2FS, JFS, inodes, buffer cache, labeling,
locking, metadata, soft-updates, LFS, portalfs, procfs,
vnodes, memory sharing, memory objects, TLBs, caching</para>
</chapter>
</part>
<part id="ipc">
<title>Interprocess Communication</title>
<chapter id="signals">
<title>Signals</title>
<para>Signals, pipes, semaphores, message queues, shared memory,
ports, sockets, doors</para>
</chapter>
</part>
<part id="networking">
<title>Networking</title>
<chapter id="sockets">
<title>Sockets</title>
<para>Sockets, bpf, IP, TCP, UDP, ICMP, OSI, bridging,
firewalling, NAT, switching, etc</para>
</chapter>
</part>
<part id="networkfs">
<title>Network Filesystems</title>
<chapter id="afs">
<title>AFS</title>
<para>AFS, NFS, SANs etc]</para>
</chapter>
</part>
<part id="terminal">
<title>Terminal Handling</title>
<chapter id="syscons">
<title>Syscons</title>
<para>Syscons, tty, PCVT, serial console, screen savers,
etc</para>
</chapter>
</part>
<part id="sound">
<title>Sound</title>
<chapter id="oss">
<title>OSS</title>
<para>OSS, waveforms, etc</para>
</chapter>
</part>
<part id="devicedrivers">
<title>Device Drivers</title>
<chapter id="oldbsddriver">
<title>4.4BSD Driver Writing</title>
<para>old ways, newbus, character/block devices, etc</para>
</chapter>
</part>
<part id="architectures">
<title>Architectures</title>
<chapter id="ia32">
<title>IA-32</title>
<para>Detail the (major) differences between IA-32, IA-64, PPC,
ARM, Sparc, Alpha, etc</para>
</chapter>
</part>
<part id="debugging">
<title>Debugging</title>
<chapter id="truss">
<title>Truss</title>
<para>various descriptions on how to debug certain aspects of
the system using truss, ktrace, gdb, kgdb, etc</para>
</chapter>
</part>
<part id="compatibility">
<title>Compatibility Layers</title>
<chapter id="linux">
<title>Linux</title>
<para>Linux, SVR4, etc</para>
</chapter>
</part>
</book>

View file

@ -0,0 +1,27 @@
#
# $FreeBSD$
#
# Build the FreeBSD Developers' Handbook.
#
MAINTAINER=asmodai@FreeBSD.org
DOC?= book
FORMATS?= html-split
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
#
# 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
# Entities
DOC_PREFIX?= ${.CURDIR}/../../..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

View file

@ -0,0 +1,232 @@
<!--
The FreeBSD Documentation Project
$FreeBSD$
-->
<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
<!ENTITY % bookinfo PUBLIC "-//FreeBSD//ENTITIES DocBook BookInfo Entities//EN">
%bookinfo;
]>
<book>
<bookinfo>
<title>FreeBSD Developers' Handbook</title>
<authorgroup>
<author>
<surname>The FreeBSD Documentation Project</surname>
<affiliation>
<address>
<email>doc@FreeBSD.org</email>
</address>
</affiliation>
</author>
</authorgroup>
<pubdate>August 2000</pubdate>
<copyright>
<year>2000</year>
<holder>The FreeBSD Documentation Project</holder>
</copyright>
&bookinfo.legalnotice;
<abstract>
<para>Welcome to the Developers' Handbook.</para>
</abstract>
</bookinfo>
<part id="introduction">
<title>Introduction</title>
<chapter id="developmentplatform">
<title>Developing on FreeBSD</title>
<para>This will need to discuss FreeBSD as a development
platform, the vision of BSD, architectural overview, layout of
/usr/src, history, etc.</para>
<para>Thank you for considering FreeBSD as your development
platform! We hope it will not let you down.</para>
</chapter>
<chapter id="bsdvision">
<title>The BSD Vision</title>
<para></para>
</chapter>
<chapter id="archoverview">
<title>Architectural Overview</title>
<para></para>
</chapter>
<chapter id="sourcelayout">
<title>The Layout of /usr/src</title>
<para></para>
</chapter>
</part>
<part id="Basics">
<title>Basics</title>
<chapter id="compilation">
<title>Compilation</title>
<para>This will include things like: compilation, makefiles, .mk
files, basic debugging, linking, secure programming
guidelines, style(9), CVS, diff, patch, etc.</para>
<para></para>
</chapter>
</part>
<part id="kernel">
<title>Kernel</title>
<chapter id="kernelhistory">
<title>History of the Unix Kernel</title>
<para>Some history of the Unix/BSD kernel, system calls, how do
processes work, blocking, scheduling, threads (kernel),
context switching, signals, interrupts, modules, etc.</para>
<para></para>
</chapter>
</part>
<part id="memory">
<title>Memory and Virtual Memory</title>
<chapter id="virtualmemory">
<title>Virtual Memory</title>
<para>VM, paging, swapping, allocating memory, testing for
memory leaks, mmap, vnodes, etc.</para>
<para></para>
</chapter>
</part>
<part id="iosystem">
<title>I/O System</title>
<chapter id="ufs">
<title>UFS</title>
<para>UFS, FFS, Ext2FS, JFS, inodes, buffer cache, labeling,
locking, metadata, soft-updates, LFS, portalfs, procfs,
vnodes, memory sharing, memory objects, TLBs, caching</para>
</chapter>
</part>
<part id="ipc">
<title>Interprocess Communication</title>
<chapter id="signals">
<title>Signals</title>
<para>Signals, pipes, semaphores, message queues, shared memory,
ports, sockets, doors</para>
</chapter>
</part>
<part id="networking">
<title>Networking</title>
<chapter id="sockets">
<title>Sockets</title>
<para>Sockets, bpf, IP, TCP, UDP, ICMP, OSI, bridging,
firewalling, NAT, switching, etc</para>
</chapter>
</part>
<part id="networkfs">
<title>Network Filesystems</title>
<chapter id="afs">
<title>AFS</title>
<para>AFS, NFS, SANs etc]</para>
</chapter>
</part>
<part id="terminal">
<title>Terminal Handling</title>
<chapter id="syscons">
<title>Syscons</title>
<para>Syscons, tty, PCVT, serial console, screen savers,
etc</para>
</chapter>
</part>
<part id="sound">
<title>Sound</title>
<chapter id="oss">
<title>OSS</title>
<para>OSS, waveforms, etc</para>
</chapter>
</part>
<part id="devicedrivers">
<title>Device Drivers</title>
<chapter id="oldbsddriver">
<title>4.4BSD Driver Writing</title>
<para>old ways, newbus, character/block devices, etc</para>
</chapter>
</part>
<part id="architectures">
<title>Architectures</title>
<chapter id="ia32">
<title>IA-32</title>
<para>Detail the (major) differences between IA-32, IA-64, PPC,
ARM, Sparc, Alpha, etc</para>
</chapter>
</part>
<part id="debugging">
<title>Debugging</title>
<chapter id="truss">
<title>Truss</title>
<para>various descriptions on how to debug certain aspects of
the system using truss, ktrace, gdb, kgdb, etc</para>
</chapter>
</part>
<part id="compatibility">
<title>Compatibility Layers</title>
<chapter id="linux">
<title>Linux</title>
<para>Linux, SVR4, etc</para>
</chapter>
</part>
</book>

View file

@ -0,0 +1,27 @@
#
# $FreeBSD$
#
# Build the FreeBSD Developers' Handbook.
#
MAINTAINER=asmodai@FreeBSD.org
DOC?= book
FORMATS?= html-split
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
#
# 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
# Entities
DOC_PREFIX?= ${.CURDIR}/../../..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

View file

@ -0,0 +1,232 @@
<!--
The FreeBSD Documentation Project
$FreeBSD$
-->
<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
<!ENTITY % bookinfo PUBLIC "-//FreeBSD//ENTITIES DocBook BookInfo Entities//EN">
%bookinfo;
]>
<book>
<bookinfo>
<title>FreeBSD Developers' Handbook</title>
<authorgroup>
<author>
<surname>The FreeBSD Documentation Project</surname>
<affiliation>
<address>
<email>doc@FreeBSD.org</email>
</address>
</affiliation>
</author>
</authorgroup>
<pubdate>August 2000</pubdate>
<copyright>
<year>2000</year>
<holder>The FreeBSD Documentation Project</holder>
</copyright>
&bookinfo.legalnotice;
<abstract>
<para>Welcome to the Developers' Handbook.</para>
</abstract>
</bookinfo>
<part id="introduction">
<title>Introduction</title>
<chapter id="developmentplatform">
<title>Developing on FreeBSD</title>
<para>This will need to discuss FreeBSD as a development
platform, the vision of BSD, architectural overview, layout of
/usr/src, history, etc.</para>
<para>Thank you for considering FreeBSD as your development
platform! We hope it will not let you down.</para>
</chapter>
<chapter id="bsdvision">
<title>The BSD Vision</title>
<para></para>
</chapter>
<chapter id="archoverview">
<title>Architectural Overview</title>
<para></para>
</chapter>
<chapter id="sourcelayout">
<title>The Layout of /usr/src</title>
<para></para>
</chapter>
</part>
<part id="Basics">
<title>Basics</title>
<chapter id="compilation">
<title>Compilation</title>
<para>This will include things like: compilation, makefiles, .mk
files, basic debugging, linking, secure programming
guidelines, style(9), CVS, diff, patch, etc.</para>
<para></para>
</chapter>
</part>
<part id="kernel">
<title>Kernel</title>
<chapter id="kernelhistory">
<title>History of the Unix Kernel</title>
<para>Some history of the Unix/BSD kernel, system calls, how do
processes work, blocking, scheduling, threads (kernel),
context switching, signals, interrupts, modules, etc.</para>
<para></para>
</chapter>
</part>
<part id="memory">
<title>Memory and Virtual Memory</title>
<chapter id="virtualmemory">
<title>Virtual Memory</title>
<para>VM, paging, swapping, allocating memory, testing for
memory leaks, mmap, vnodes, etc.</para>
<para></para>
</chapter>
</part>
<part id="iosystem">
<title>I/O System</title>
<chapter id="ufs">
<title>UFS</title>
<para>UFS, FFS, Ext2FS, JFS, inodes, buffer cache, labeling,
locking, metadata, soft-updates, LFS, portalfs, procfs,
vnodes, memory sharing, memory objects, TLBs, caching</para>
</chapter>
</part>
<part id="ipc">
<title>Interprocess Communication</title>
<chapter id="signals">
<title>Signals</title>
<para>Signals, pipes, semaphores, message queues, shared memory,
ports, sockets, doors</para>
</chapter>
</part>
<part id="networking">
<title>Networking</title>
<chapter id="sockets">
<title>Sockets</title>
<para>Sockets, bpf, IP, TCP, UDP, ICMP, OSI, bridging,
firewalling, NAT, switching, etc</para>
</chapter>
</part>
<part id="networkfs">
<title>Network Filesystems</title>
<chapter id="afs">
<title>AFS</title>
<para>AFS, NFS, SANs etc]</para>
</chapter>
</part>
<part id="terminal">
<title>Terminal Handling</title>
<chapter id="syscons">
<title>Syscons</title>
<para>Syscons, tty, PCVT, serial console, screen savers,
etc</para>
</chapter>
</part>
<part id="sound">
<title>Sound</title>
<chapter id="oss">
<title>OSS</title>
<para>OSS, waveforms, etc</para>
</chapter>
</part>
<part id="devicedrivers">
<title>Device Drivers</title>
<chapter id="oldbsddriver">
<title>4.4BSD Driver Writing</title>
<para>old ways, newbus, character/block devices, etc</para>
</chapter>
</part>
<part id="architectures">
<title>Architectures</title>
<chapter id="ia32">
<title>IA-32</title>
<para>Detail the (major) differences between IA-32, IA-64, PPC,
ARM, Sparc, Alpha, etc</para>
</chapter>
</part>
<part id="debugging">
<title>Debugging</title>
<chapter id="truss">
<title>Truss</title>
<para>various descriptions on how to debug certain aspects of
the system using truss, ktrace, gdb, kgdb, etc</para>
</chapter>
</part>
<part id="compatibility">
<title>Compatibility Layers</title>
<chapter id="linux">
<title>Linux</title>
<para>Linux, SVR4, etc</para>
</chapter>
</part>
</book>