Commit graph

97 commits

Author SHA1 Message Date
Dima Dorfman
c2eac56e0a Reference %authors by its PUBLIC rather than SYSTEM identifier. This
fixes the cases where the Developer's Handbook is separated from the
Handbook (i.e., different parent directories), and where authors.ent
is somewhere other than "../handbook".
2001-08-16 03:34:59 +00:00
Jim Mock
20a3ac82d8 Fix the explanation of src/share.
PR:		29666
Submitted by:	Alexey V. Neyman <alex.neyman@auriga.ru>
2001-08-13 06:38:59 +00:00
Jeroen Ruigrok van der Werven
cd30a7ae84 Fix 404. Add ../../ to the relative path. This might be changed to
a &base; usage later on.

Submitted by:	checkbot
2001-07-25 14:37:51 +00:00
Jeroen Ruigrok van der Werven
5b2d3bbd6a Add some introductory text. 2001-07-22 20:08:33 +00:00
Jeroen Ruigrok van der Werven
905b48ecf8 Put the information about the versions and availability in their own
paragraph.
2001-07-22 14:00:50 +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
Dima Dorfman
f312a3debb The second argument to DECLARE_MODULE is a moduledata_t, not a
modeventhand_t.
2001-07-19 10:37:35 +00:00
Chern Lee
3e8d98b70a Standardize:
TCL -> Tcl
ethernet -> Ethernet
ftp (noun) -> FTP

Approved by:	murray
2001-07-17 22:20:51 +00:00
Chern Lee
6dbf07d805 Fix/Standardize:
internet -> Internet
can not -> cannot
CD-ROM -> CDROM
cdrom -> CDROM
UNIX -> Unix

To be standardized with the rest of the doc tree.

Approved by:	murray
2001-07-17 20:51:52 +00:00
Chern Lee
66585ffb37 Add indexterms to policy chapter.
Contributed by Valentino Vaschetto <logo@blackened.com>
2001-07-13 22:21:27 +00:00
Tom Hukins
0b28dda65d Remove double world and add full stop.
PR:		docs/28702
Submitted by:	Giorgos Keramidas <keramida@ceid.upatras.gr>
2001-07-07 13:25:07 +00:00
Dima Dorfman
4a5e851cb2 DocBook police: open and close tags for <screen> should cuddle up to
the contents within.
2001-07-06 13:03:06 +00:00
Nik Clayton
4e521b8bb2 Makefile's to make it easy to build individual handbook chapters. These
are *not* recursed in to by the top level Makefile.
2001-06-30 14:55:40 +00:00
Dima Dorfman
b0c3cb4fcc Remove duplicate words where appropriate.
Inspired by:    PRs 28356, 28359; tyler spivey <tspivey8@home.com>
2001-06-23 06:57:06 +00:00
Murray Stokely
2cf4943a03 Turn on our nascent index by default 2001-06-23 04:57:32 +00:00
Daniel Harris
5a583aa361 Correct some typos and clarify.
PR:		28352
Submitted by:	author
2001-06-22 21:29:18 +00:00
Murray Stokely
33c100c32d Add a chapter on sockets programming.
Submitted by:	G. Adam Stanislav
2001-06-22 08:49:14 +00:00
Chris Costello
d7cec802c5 Move mailing-lists.ent out of the Handbook and into the language-specific
share/sgml directories, create a public identifier for it and replace all
SYSTEM references to the file with PUBLIC references.

There was no repo-copy made of these files as there is no important
history to preserve.
2001-06-21 03:38:34 +00:00
Jens Schweikhardt
6dacbefe3e Fix a grammar bogon and don't start a <note> with "Note"
because you end up with a double note. No content changes.
2001-06-17 12:29:19 +00:00
Dima Dorfman
9ad6a380e5 Correct a typo.
PR:		28205
Submitted by:	G. Adam Stanislav <adam@whizkidtech.net>
2001-06-16 22:04:58 +00:00
Murray Stokely
241b09897e Updates to the x86 assembly language chapter.
This is a very unusual piece of documentation in that it is maintained
by an outside author who thinks he has a better home-grown
documentation management system than ours, so he now supports
DocBook/SGML as an "output" format to his own system.  His output is
perfectly valid DocBook but the indentation is mostly non-existent,
and 'tidy -xml' breaks things.

Anyway, please send updates to this chapter directly to the submitter.

Submitted by:	G. Adam Stanislav (adam@whizkidtech.net)
Discussed on:   freebsd-doc
2001-06-15 21:26:07 +00:00
Murray Stokely
63965b7d0f Add section id's so that this document can be linked from others in
the tree.

PR:		docs/28114
Submitted by:	"G. Adam Stanislav" <adam@whizkidtech.net>
2001-06-13 18:18:58 +00:00
Tom Hukins
cc853292bc Replace erroneous occurences of "the the" with "the" throughout the docs
PR:		28086
Submitted by:	Félix-Antoine Paradis <reel@sympatico.ca>
2001-06-13 11:37:03 +00:00
Eric Melville
5284d9ba77 Minor typo corrections.
Approved by:	murray
2001-06-03 00:37:08 +00:00
Dima Dorfman
0ee9ac2ae9 Correct a spelling error.
Submitted by:	G. Adam Stanislav <adam@whizkidtech.net>
2001-06-02 23:24:10 +00:00
Murray Stokely
acd6619ae0 Add ~40 index terms to this chapter. A couple of minor tweaks to
doc.docbook.mk are needed for this to work with GEN_INDEX defined but
that will be committed soon enough.

Reviewed by:	-doc (months ago)
2001-05-17 01:03:07 +00:00
Murray Stokely
a6d73c002c Use author entities more consistently now that we include
../handbook/authors.ent.
2001-05-14 03:15:19 +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
d771da3e3e Add a more useful abstract, stolen from the Handbook. 2001-05-14 01:36:20 +00:00
Nik Clayton
407706f4b8 Add some information about using "make depend" to help automatically
maintain dependencies between include files and source files.

PR:		docs/26743
Submitted by:	Edwin Groothuis <edwin@mavetju.org>
2001-05-13 16:34:42 +00:00
Murray Stokely
e2ee892e4b Oops, forgot to add SRCS+= x86/chapter.sgml. 2001-05-11 10:27:00 +00:00
Murray Stokely
48e08f6677 Import Adam Stanislav's Assembly Language Tutorial as a chapter of the DH.
SGML Markup by: Wylie Stillwell <wylie@osd.bsdi.com> and
	        Valentino Vaschetto <logo@osd.bsdi.com>
Approved by:	Adam Stanislav
2001-05-11 10:20:34 +00:00
Murray Stokely
27694acf92 Import Sergey Babkin's ISA device driver tutorial.
(This file was accidentally left out of the last commit)

SGMLified by:	emacs, Wylie Stilwell, Valentino Vaschetto, and I
Approved by:	Sergey Babkin
Obtained from:	Daemonnews
2001-05-02 01:56:01 +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
Murray Stokely
98281ab7b5 Document abort(3) and gcore(1) as additional ways to create a core
dump.

PR:		26728
Submitted by:	Edwin Groothuis <edwin@mavetju.org>
2001-04-20 12:09:40 +00:00
Dima Dorfman
9787395178 It's the Morris Internet Worm, not the Moorse Internet Worm.
Submitted by:	"Dr Nancy's Sweetie" <kilroy@copland.rowan.edu>
2001-04-18 19:33:27 +00:00
Nik Clayton
35f6b4ed80 Use <corpauthor> properly. My fault for providing flawed examples for
people to copy from.
2001-04-18 08:57:47 +00:00
Dima Dorfman
a0415e82f0 Remove references to first-person pronouns ("I", "me", etc.): all they
do is serve to confuse the reader (who is this "I"?).  Stuff inside
<question> tags in the mini-faq's and clearly-attributed blocks was
left alone.
2001-04-17 01:37:48 +00:00
Murray Stokely
3f8dcd2eb1 Add beginnings of a chapter on our USB Device Driver framework. More
diagrams and content to come.

Obtained from:	Nick Himba's various presentations
2001-04-13 09:05:13 +00:00
Murray Stokely
256b609358 Add missing </para> tags. 2001-04-13 08:09:03 +00:00
Nik Clayton
2d71ef8cb4 Typo: contribued -> contributed 2001-04-09 09:35:48 +00:00
Nik Clayton
0184081635 Use <envar> rather than <systemitem class="...">, which was breaking the
build.
2001-04-09 09:26:16 +00:00
Murray Stokely
06e1a7b45d indention and spelling fixes. 2001-04-09 08:42:04 +00:00
Murray Stokely
53f5f0487c Add PCI resource allocation section for (BARs, IRQs, DMA) 2001-04-09 08:26:38 +00:00
Dima Dorfman
caa6994914 DocBook police: open and close tags for <programlisting> should cuddle
up to the contents within.

Approved by:	nik
2001-04-09 00:33:58 +00:00
Murray Stokely
73daea17a1 o Add a chapter on writing a CAM SCSI host bus adapter driver by
Sergey Babkin (first published in Daemonnews).
o Update copyrights for 2001.
o Include the authors.ent file from the FreeBSD Handbook

Approved by:	babkin
2001-03-29 06:14:42 +00:00
Dag-Erling Smørgrav
805f30d761 Rework the paragraph about finding the relocation address for kernel
modules; it was repetitive and slightly confused.
2001-01-23 12:25:31 +00:00
Jake Burkholder
31804303bc Document the callout_lock and the proctree_lock, which is soon to be
added.

Reviewed by:	jhb
2000-12-11 20:46:17 +00:00
Alexander Langer
359f511947 Now REALLY limit to character + network devices. 2000-12-04 11:39:41 +00:00
Alexander Langer
b73ba86320 Block-devices are obsolete. 2000-12-04 11:34:57 +00:00