Commit graph

361 commits

Author SHA1 Message Date
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
John Baldwin
9b75bcbfaa Add a new chapter to the kernel section that will eventually document all
of the locks used to make the kernel MP safe.
2000-11-29 04:15:17 +00:00
Jeroen Ruigrok van der Werven
e1fe303667 Split off PCI chapter.
Submitted by:	murray
2000-11-28 19:07:46 +00:00
Jeroen Ruigrok van der Werven
fc669e67ec Split off the driversbasic chapter and put it in its own file.
Submitted by:	murray
2000-11-28 19:04:09 +00:00
Jeroen Ruigrok van der Werven
1ac9fc70ea Split the secure programming section off into it's own file.
Submitted by:	murray
2000-11-28 18:31:39 +00:00
Jeroen Ruigrok van der Werven
57f0c002c6 Split off the tools section into its own directory.
Asked for by:	murray
2000-11-28 18:21:36 +00:00
Jeroen Ruigrok van der Werven
53842b289f Add the chapters entity file for the Developer's Handbook.
Submitted by:	murray
2000-11-28 18:03:54 +00:00
Murray Stokely
eeb803f1dc Integrate James Raynard's programming tutorial into the Developer's Hanbook.
I was unable to contact James to ask for his permission.

Discussed on: -doc
2000-11-16 19:02:53 +00:00
Dag-Erling Smørgrav
2c9f882842 Minor wording tweak. 2000-11-15 12:42:07 +00:00
Dag-Erling Smørgrav
a43d4233ca Update the description of how to load modules in gdb, and separate it from
the section on remote debugging since it also applies to crash dumps.  Thanks
to grog for his gdb macros, which pointed me in the right direction.

Reviewed by:	nik
2000-11-15 12:40:05 +00:00
Joseph Koshy
48531a3b88 GDB now needs an explicit `-k' option to switch to kernel debugging mode. The
tactic of invoking GDB under the name of `kgdb' has not worked for a while.
Correct the `Kernel Debugging' chapter of the Handbook to reflect this change.

Reviewed by:	ben
2000-11-07 09:08:11 +00:00
Murray Stokely
a86ed65644 Added chapter on secure programming in basics section and added a
bibliography.
2000-11-06 13:52:26 +00:00
Murray Stokely
87fddebcea First significant batch of content for the Developer's Handbook.
* Added introductory content for device driver chapter.
   * Included some example pseudo device drivers with (not-enough) commentary.
   * Added new chapters to the framework
   * Included pointers to more information in some of the unwritten chapters.
2000-11-06 10:22:11 +00:00
Alexey Zelkin
d727224850 Fix kerberos release number: s/V/5 2000-10-06 15:36:45 +00:00
Murray Stokely
376c5138c6 Following asmodai's nice skeleton of the developers' handbook, this
change adds a section to Chapter 4 on the layout of /usr/src.
2000-10-03 07:34:34 +00:00
Chris Costello
8f61bed60b Properly capitalize section <title> tags. 2000-08-20 17:18:43 +00:00
Jeroen Ruigrok van der Werven
e39773fe6a Add the initial skeleton of the Developers' Handbook. 2000-07-30 18:20:23 +00:00
Ben Smithurst
9116abfe00 Update the bit about stripping the kernel:
* stripping is done automatically now
* ELF kernels don't need to have the full debug symbol table loaded.

PR:		19648
Submitted by:	Jeff Blaine <jblaine@mitre.org>
Reviewed by:	grog, nik
2000-07-14 21:57:34 +00:00
Jim Mock
dfefe8d45b The third, and final episode in the attack of the spelling police series.
Well, at least for now anyway :-)
2000-06-14 20:30:40 +00:00
Jim Mock
370586999f Attack of the spelling police, part II. 2000-06-14 00:47:37 +00:00
Jim Mock
3302fdee27 Change &ldquo;...&rdquo; to <quote>...</quote> as per a discussion on
-doc.

Suggested by:	nik
2000-06-08 01:56:23 +00:00
Chris Costello
9d66d5d223 Properly capitalize section titles. Remove capitalization on `is'', `and'',
etc.  Capitalize all other words in titles.

Reviewed by:	jim
2000-04-03 02:15:43 +00:00
Neil Blakey-Milner
7bbaccde07 While I'm looking for ugly filenames, add a nice filename for
contributed software policies.
2000-03-25 17:02:35 +00:00
Martin Cracauer
6e041c10c0 Note that serial gdb is not necessarily on first serial port,
but on that one with sio flags 0x80 in kernel config.
1999-12-16 16:04:24 +00:00
Nik Clayton
f1149f86ae Replace reference to diediedie() with one to panic.
PR:             docs/14112
Submitted by:   Thierry.Besancon@lps.ens.fr
Patch from:     ru
1999-12-16 01:53:05 +00:00
Jesus Rodriguez Cuesta
7299e0152d Add a forgotten "</para>" 1999-11-15 21:17:20 +00:00
David E. O'Brien
f92d0dc446 Minorly update for ELF. 1999-11-15 04:42:59 +00:00
Chris Costello
7cfb0ff20b Rid blank lines of whitespace.
(Translation teams:  You can ignore this commit.)
1999-11-07 01:54:56 +00:00
Peter Wemm
5ff728b8ca $Id$ -> $FreeBSD$ 1999-09-06 06:53:43 +00:00
Nik Clayton
122d319794 "../handbook.sgml" -> "../book.sgml" in Emacs local variables section. 1999-08-23 21:24:10 +00:00
Nik Clayton
f18b900b84 Fix many typos. Much kudos to the submitter for this effort.
PR:             docs/12956
Submitted by:   Neil Blakey-Milner <nbm@rucus.ru.ac.za>
1999-08-05 20:48:25 +00:00
Nik Clayton
838f8740b9 Any variant on "freebsd.org" (all cases) mapped to "FreeBSD.org".
PR:             docs/12842
Submitted by:   Chris Costello <chris@calldei.com>
1999-07-28 20:23:32 +00:00
Nik Clayton
9cc9facec2 A new section explaining the policy on encumbered files in the source
tree.  Based on text from phk, and run through the txt2docbook filter.
1999-07-07 00:00:18 +00:00
Nik Clayton
419cffe7ba Update information on how to build a debug kernel, fix a typo and
a contraction.

PR:             docs/11849
Submitted by:   chris@calldei.com
1999-05-29 12:55:39 +00:00
David E. O'Brien
c9769af30f It appears "-g" is now the right option to ``strip'' rather than "-d". 1999-05-22 16:36:02 +00:00
Greg Lehey
b607de5d28 Remove <blockquote> tag around quoted screen output.
Prodded-by:	nik
1999-04-12 04:41:20 +00:00
Greg Lehey
e080c1791b Tidy up displays so that they fit onto a printed page (sort of). 1999-04-06 01:26:25 +00:00