Commit graph

348 commits

Author SHA1 Message Date
Warner Losh
301b3e945b document, in some detail with explainations and assides, how to add a
new device entry for PC Card devices with NEWCARD.

I've not connected this to the build because I can't test it locally
on this machine.  Feel free to fix any problems in this file, so long
as you don't change the semantic meaning without asking me.  I write
code, not docs :-)

Thanks to the person who attended my devd talk in INTEROP+NETWORLD
2003 Tokyo BSD BOF via IRC who asked me how to do this in the Q&A
section.  An excellent question that I glossed over at the BOF, but
hopefully this rectifies the problem.

Eventually, I'd like to expand this to include more information about
how to write a driver for a PC Card or CardBus device, but for now
this will have to do.
2003-07-04 00:47:27 +00:00
Warner Losh
6891feb81d Three content changes:
1) Use the new c99 initialization in the pci driver example.  Also,
	   don't claim this device is a tty.
	2) Add notes about caution needed during detach routine wrt interrupts
	   and locking.
	3) Add note that vtophys is deprecated and to use busdma instead.
	   Since the busdma API isn't completely settled for 5.x yet,
	   don't document it.  I'll leave that to others when the API is
	   done being frobbed.
2003-07-03 22:30:10 +00:00
Robert Watson
115626b75a Update label externalization entry point descriptions for the recent
change to use sbufs instead of C strings.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-06-23 02:04:49 +00:00
Murray Stokely
510f5f97ef Use the &unix; entity for the first significant occurrence of the word
in this document (will be rendered with a (R) symbol.)
2003-06-17 20:19:42 +00:00
Murray Stokely
8e984d0048 Include Trademark Legend in the preamble. 2003-06-17 20:16:35 +00:00
Giorgos Keramidas
329fbacce4 Minor English grammar nit. Translators please ignore. 2003-05-21 21:01:23 +00:00
Giorgos Keramidas
987646d5d3 Correct a typo: occured -> occurred. 2003-05-21 20:58:39 +00:00
Hiten Pandya
46c9ee323c Use a <surname> tag. While I am there, beautify the
markup of the <author> tag.

Approved by: des (mentor)
2003-05-15 11:32:18 +00:00
Hiten Pandya
bbffb0e6dc Change 'automagically' into 'automatically'.
Approved by: des (mentor)
2003-05-05 19:48:17 +00:00
Murray Stokely
8c4d32e232 Clarify dumpon/swapon usage wrt getting a kernel crash dump.
PR:		docs/50790
2003-05-05 03:40:01 +00:00
Robert Watson
ec6d7d60d9 Since the future of jailNG is unclear, remove text describing it from
the jail chapter.  FYI, this chapter is increasingly out-of-date due
to recent 5.x changes.
2003-04-27 16:02:13 +00:00
Hiroki Sato
f6cd99b654 Back out WITH_DOCFORMAT_NAVI_LINK?=YES in Makefile. The navi-link
is generated when ${WITH_DOCFORMAT_NAVI_LINK} is defined or
${FORMATS} includes "html" and "html-split."
2003-04-22 18:35:44 +00:00
Robert Watson
05e4fc5873 Trim incomplete Userland API section, it contributes nothing over
the existing Userland Architecture section.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 23:10:35 +00:00
Robert Watson
fa27b75e0f Add more to the MAC Framework Kernel Architecture:
- Add Management Interfaces (sysctls, tunables, et al).
- Add Concurrency and Synchronization (busy count handling to synchronize
  policy loading).
- Add Policy Registration (management of active poliy lists).
- Flesh out Labeling Support to talk about label initialization and
  life cycles, allocation semantics.
- Add System Calls.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 21:00:56 +00:00
Robert Watson
8c1173c2f6 Spellcheck. 2003-04-20 18:10:58 +00:00
Robert Watson
96eb481cbd Resort and organize some sections:
- Move Userland Architecture down to the Userland APIs section.

- Push most of the Policy-related subsections into the MAC Policy
  Architecture section.  Tweak a little language so it makes
  sense.
2003-04-20 18:01:22 +00:00
Robert Watson
a7b83db368 Remove "MAC Framework" from a bunch of headings where it seems
redundant.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 17:27:14 +00:00
Robert Watson
be5924b944 Break out Policy Background from the Introduction.
Note that the MAC Framework can also be used to express DAC policies.

Push the MAC Framework Policy Elements section up a level to sect1 and
name it "MAC Policy Architecture".

Stick "MAC" in front of the Policy Entry Points section header to
improve consistency.
2003-04-20 17:09:56 +00:00
Robert Watson
f4d495b054 Some more structural changes for the MAC Framework chapter of the
Developer's Handbook: break out the "Entry Point Framework" section
into a number of sections: MAC Policy Declaration, Entry Point
Introduction, MAC Policy Entry Point Reference.  Re-order sections
a bit so there's a more logical progression and fewer large chunks
of text over many pages.  This greatly improves readability.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 05:48:12 +00:00
Robert Watson
93cbd61b9c Document the MPC_LOADTIME_FLAG_LABELMBUFS load-time policy flag and
its possible interactions with the MPC_LOADTIME_FLAG_NOTLATE flag.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 04:59:57 +00:00
Robert Watson
5656cc3abb Replace "There's nothing here yet" in the Userland API section of
the MAC Framework Chapter of the Developer's Handbook with a
cross-reference the the mac(3) man page for the time being.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 04:45:08 +00:00
Robert Watson
0bca361723 - Break out many of the paragraphs in the "Kernel Architecture" section
of the MAC Framework chapter of the Developer's Handbook into their
  own <sect2> sections.

- Re-order the Policy Elements sect2 to the end of the section since
  most of the remainder of the subsections talk about parts of the
  Framework, not module structure.

- Add text relating to the support for persistent labeling using
  extended attributes on supporting file systems.

- Add concurrency/synchronization primitives to the list of framework
  elements.

This section needs more work, and will probably grow sub-sections on
most of the major elements in the element list.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 04:32:55 +00:00
Robert Watson
2b6ca199ef GC a stray <sect3> from an earlier commit.
GC the sample policy modules section since there's nothing there yet.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 04:17:22 +00:00
Robert Watson
1d668180a6 Found the missing description of mpo_destroy_vnode_label(), it was in
the label management calls section.  GC the dup copy.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 04:12:11 +00:00
Robert Watson
bdfc29bc51 - Synchronize label initialization and destruction arguments: in some
cases, the object pointer was still present as an argument to
  label init/destroy calls, although it was removed in the source a
  while back.  In some cases, we've added blocking dispositions to
  initialization calls that previously didn't have them (ipq), so
  add that also.  Generally call 'how' 'flag' instead to match the
  prototypes in mac_policy.h.

- Add missing descriptions of mpo_destroy_vnode_label(), and the
  recently added mpo_copy_mbuf_label().

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 04:10:20 +00:00
Robert Watson
e51825dea9 Add two sub-sections to the MAC Framework userland architecture section
of the Developer's Handbook: text on the APIs to access and manipulate
labels on objects, and a brief description of how labels may currently
be set on users using login.conf.  This text could also use some more
work, but is probably an improvement over the previous lack of text.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-20 03:53:49 +00:00
Hiroki Sato
4f8b26641c - Add WITH_DOCFORMAT_NAVI_LINK to mk/doc.docbook.mk and
enable it in en_US.ISO8859-1/ and ja_JP.eucJP/.

- Add PUBLIC "-//FreeBSD//ENTITIES DocBook Language Specific Entities//EN"
  and l10n.ent for entity localization.

- Use share/misc/docbook.css for indentiation of <programlisting>
  and <screen>.

- Add some missing $FreeBSD$.
2003-04-19 11:39:30 +00:00
Robert Watson
105124763b Flesh out the kernel architecture section of the MAC Framework
bits of the Developer's Handbook some.  Needs more work, but now
goes into a bit more detail.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-19 03:32:43 +00:00
Robert Watson
6304541cd0 Slightly flesh out the synopsis: this chapter is not just about MAC
policies, but more generally about a framework for access control
extension.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, Network Associates Laboratories
2003-04-19 00:56:54 +00:00
Robert Watson
4605a95479 Add a placeholder paragraph for the user architecture section, replacing
the "..." with a brief summary of what is to come.
2003-04-18 03:45:42 +00:00
Robert Watson
499253ef61 Apply a spell checker to the first few sections. 2003-04-18 02:25:24 +00:00
Marc Fonvieille
a083e812b3 s/close s;/close(s);/
Submitted by:	BelletJr@aol.com
2003-04-12 11:32:40 +00:00
Marc Fonvieille
87244b4a45 Remove files moved to share/images/books. 2003-04-11 09:34:49 +00:00
Marc Fonvieille
47f6d4e260 Commit images separation from en_US.ISO8859-1/ directory to
share/images.  To link "generic" images (share/images ones) from
Makefiles use IMAGES_EN and to link localized images use IMAGES.
For an example look at en_US.ISO8859-1/books/handbook/Makefile
2003-04-11 09:21:15 +00:00
Giorgos Keramidas
6dd95937d9 Put my flame resistant suit on, and remove all unnecessary duplication
of URL text in <ulink> attributes, reducing the probability of typos
in future changes to the docs.
2003-04-11 01:11:39 +00:00
Christian Brueffer
6b18444bae o Spell the names of dfr and mdodd correctly
o Some punctuation fixes
o perl has been removed from 5.x, sendmail is a better example for
  contributed software

PR:		50735
Submitted by:	arved
2003-04-08 22:54:23 +00:00
Sean Chittenden
36cbe51ebd Small whitespace fix to improve readability of the lisp code in the .emacs
example.
2003-04-04 03:39:08 +00:00
Tom Rhodes
a1796ddaf3 Update a file location: sys/pci/sym.c > sys/dev/sym/sym_hipd.c.
Pointed out by:	Kenneth Stailey <kstailey@yahoo.com>
2003-03-06 21:18:33 +00:00
Giorgos Keramidas
117c7c4773 The initial value of the instruction pointer after processor reset is
not 0xffffff00 but 0xfffffff0.  Verified by checking section 10.1 of
"Intel 80386 Reference Programmer's Manual" at:
http://people.freebsd.org/~jhb/386htm/s10_01.htm

PR:		docs/48571
Submitted by:	Rui Lopes <rui@ruilopes.com>
2003-03-01 00:56:20 +00:00
Ceri Davies
2d9cd0e3bd Small grammatical fix. 2003-02-18 18:33:03 +00:00
Ceri Davies
0692de8608 Split the "parent" and "alignment" arguments to bus_dma_tag_create into two
separate listitems.

PR:		docs/48427
Submitted by:	anholt
2003-02-18 18:26:52 +00:00
Sean Chittenden
30dd31cfc8 Use own dogfood and remove whitespace pointed out through by displaying
trailing whitespace.

PR:		docs/48371
Approved by:	ceri
2003-02-17 20:09:57 +00:00
Sean Chittenden
563de07c7d Update the .emacs example to display trailing whitespace (nice and red by
default).  Americanize spelling while I'm at it:
	s/optimise/optimize/g &&
	s/intepret/interpret/g

PR:		docs/48371
Approved by:	ceri
2003-02-17 20:06:34 +00:00
Marc Fonvieille
34d7a51850 Add 2003 for the copyright. 2003-02-09 11:28:09 +00:00
John Baldwin
6fa60155c8 Check in some updates I made to this ages ago which are at least still
partially applicable.  This does at least remove some mutex flags that
were obsoleted a long, long time ago as well as rename the lockmgr section
to be more generic.
2003-02-03 18:47:06 +00:00
Marc Fonvieille
5a7b8715a4 Typo fixing: s/libparnoia/libaparnoia
PR:		docs/47806
Submitted by:	Alexander Pohoyda <alexander.pohoyda@gmx.net>
2003-02-02 11:19:37 +00:00
Marc Fonvieille
ace2db0de6 Fix a typo.
Submitted by:	Craig Rodrigues <rodrigc@attbi.com>
2003-02-02 09:14:16 +00:00
Tom Hukins
e425fbbac8 s/freebsd.org/FreeBSD.org/ 2003-01-21 19:28:27 +00:00
Chris Costello
db7a21561d Update the MAC policy ops entry point list and sort it.
Sponsored by:	DARPA, Network Associates Laboratories
Obtained from:	The TrustedBSD Project
2003-01-14 22:47:24 +00:00
Peter Pentchev
1f359cbbab /tmp/msg 2003-01-12 18:20:55 +00:00
Tom Rhodes
c306bdf707 Remove unneeded <authorgroup> tags.
Use asmodai (for historical reasons)

Submitted by:	Hiten Pandya <hiten@unixdaemons.com>
2003-01-06 06:31:56 +00:00
Tom Rhodes
babf16bc4f Whitespace... Eliminated. 2003-01-06 06:14:22 +00:00
Robert Watson
d5f12ddfea Add some filler text regarding MAC userland APIs until we have a table
in place.
2002-12-22 05:09:15 +00:00
Robert Watson
5959fcca17 Remove clause three of license.
Authorized by:	NETA
2002-12-22 04:37:00 +00:00
Marc Fonvieille
7d6701c693 s/subr_bus.h/subr_bus.c/
Submitted by:	Hiten Pandya
2002-12-17 19:01:46 +00:00
Marc Fonvieille
01bcf1ded6 Add infos about devfs(5) where needed.
Submitted by:		keramida
2002-12-02 21:11:55 +00:00
Marc Fonvieille
84116021ba s/softupdates/Soft Updates/
Submitted by:	Hiten Pandya <hiten@uk.FreeBSD.org>
2002-12-01 13:39:29 +00:00
Ceri Davies
ac307bceb7 s/seperate/separate/ 2002-11-20 19:41:10 +00:00
Chris Costello
5c76844791 Change from a very article-esque chapter title to a more appropriate title
for the Developers' Handbook.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2002-10-22 00:48:30 +00:00
Marc Fonvieille
bdf348014f Add missing tags, and s/-4.x/4.X 2002-10-13 16:22:23 +00:00
Marc Fonvieille
e2e04c2b7c Fix the vm chapter layout in order to have a TOC.
Submitted by:	Hiten Pandya <hiten@angelica.unixdaemons.com>
2002-10-13 16:15:22 +00:00
Warner Losh
5dc1ae8669 Give a better bus address example than 0x23c, since most ISA devices
map to 8 or 16 byte boundaries.  Use 0x230 instead.  Remove part of a
bullet item about documenting each device_t field here because a
device_t is supposed to be an opaque data structure to the client
drivers.
2002-09-08 22:08:56 +00:00
Alfred Perlstein
dd540ae7ec Rename file.
Requested by: keramida
2002-09-08 21:47:07 +00:00
Alfred Perlstein
7e4ba0309d Add a chapter to describe newbus.
Submitted by: Hiten Pandya <hiten@angelica.unixdaemons.com>
PR: docs/42557
2002-09-08 21:25:24 +00:00
Giorgos Keramidas
05281d92ce Unbreak </literal>. 2002-08-31 20:22:20 +00:00
Giorgos Keramidas
1703a2c741 <quote> properly. 2002-08-31 20:18:23 +00:00
Giorgos Keramidas
e07216f989 - Point to pub/FreeBSD/ports/packages/Latest/ for packages.
- Fix gcl.tgz package link.
- Add more LISP implementation package links.
- Mention that Perl is a package now (except for 4.x releases).
- Add description & package links for:
  Icon, Logo, Python, Tcl.
- Add link to lang/gpc port.
2002-08-30 21:10:16 +00:00
Giorgos Keramidas
56f7702269 Grammar fix. Avoid starting sentence with "And". 2002-08-30 20:55:12 +00:00
Giorgos Keramidas
c51706e25a Be more explicit about package links. 2002-08-30 20:54:09 +00:00
Giorgos Keramidas
6b04bdb5d5 Be a little more liberal in spacing within lists,
to allow moving by `paragraph' in various parts more quickly.
Translators ignore this, since it only changes whitespace.
2002-08-28 20:57:41 +00:00
Giorgos Keramidas
fe348dc248 Grammar fix. 2002-08-28 19:33:57 +00:00
Giorgos Keramidas
6282b35e9b Whitespace only changes. Wrap stuff as much as possible under
70 columns.
2002-08-28 19:19:51 +00:00
Giorgos Keramidas
a828c35ea5 Add a few more <literal> or <filename> to boot[02]. 2002-08-28 19:09:02 +00:00
Giorgos Keramidas
45bdd9c222 Send Freud into oblivion to make Jung happier with FreeBSD. 2002-08-28 18:38:52 +00:00
Giorgos Keramidas
d164c7241e Grammar fix. Translators can ignore this. 2002-08-28 18:30:08 +00:00
Ceri Davies
2b6ce9005a Make consistent use of <userinput>.
PR:		docs/41286
Submitted by:	Martin Heinen <martin@sumuk.de>
2002-08-27 16:58:05 +00:00
Marc Fonvieille
ebaf5e9b48 Fix a typo in program listing.
PR:		docs/41814
Submitted by:	Maxim Maximov <mcsi@agava.com>
2002-08-20 12:26:29 +00:00
Marc Fonvieille
538c34d2d8 s/sevice/service
PR:		docs/41811
Submitted by:	Maxim Maximov <mcsi@agava.com>
2002-08-20 12:15:39 +00:00
Robert Watson
6c33af52cd Expand the synopsis for the MAC framework a bit to include additional
information on what MAC is, how the MAC framework supports MAC policies
in FreeBSD, etc.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2002-08-19 13:58:00 +00:00
Robert Watson
93af0d314d Add ENOENT to the error precedence chart.
Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2002-08-19 13:42:17 +00:00
Robert Watson
ee7a6550ed Minor spelling tweak for discretionary. 2002-08-19 13:39:50 +00:00
Chris Costello
1c8ff53e4f Introduce support for Mandatory Access Control and extensible
kernel access control.

Document the kernel side of the MAC policy architecture.  This
is a little out of date at the moment.  Some parts to be filled
in as things are developed, and much is subject to change.  It
will, however, give developers a good idea of how things work.

Obtained from:	TrustedBSD Project
Sponsored by:	DARPA, NAI Labs
2002-08-19 04:38:25 +00:00
Murray Stokely
2c4941f92c Remove the "History of the Unix Kernel" place-holder chapter. That
material does not belong here.  Replace it with the new "Booting and
Kernel Initialization" chapter.
2002-07-29 06:19:30 +00:00
Murray Stokely
6800086bfb Add a chapter about the FreeBSD Boot Process and Kernel
Initialization.  Much like the rest of the Developer's Handbook, this
needs a lot of work, but is better than nothing.

PR:		docs/39471
2002-07-29 06:18:01 +00:00
Ceri Davies
2720833199 Grammatical fix. 2002-07-19 14:47:04 +00:00
Tom Rhodes
d4b003e30a FreeBSD documentation project prefers to use manual pages over man pages,
hence some documents should reflect this.

Tossed around on: -doc -developers
2002-07-11 19:08:31 +00:00
Tom Hukins
63767bc5ab Fix typo
Submitted by:	Douglas José Pereira dos Santos <dsantos@impsat.com.br>
2002-06-27 19:32:34 +00:00
Ceri Davies
4059045d53 Americanise^H^ze (s/behaviour/behavior/g). 2002-05-22 14:27:13 +00:00
Ceri Davies
1f37332cae s/in to/into/ where it makes sense.
This commit can very likely be ignored by translators.
2002-05-22 08:36:43 +00:00
Tom Rhodes
9ba764ae23 Consistancy checks: s/file system/filesystem/g 2002-05-16 01:42:28 +00:00
Sebastien Gioria
b2fa4b898d Typo fix
PR:             docs/37158
Submitted by:   Christophe Juniet <cjuniet@entreview.com>
2002-04-16 21:20:59 +00:00
Giorgos Keramidas
67a1702cec Remove almost all instances of "try and <verb>" from the docs.
There is one remaining place in the fdp-primer, but that needs
a bit more work.

Inspired by:	docs/36462 (Gary W. Swearingen <swear@blarg.net>)
Reviewed by:	ceri, trhodes
2002-04-07 23:52:37 +00:00
Jeroen Ruigrok van der Werven
5152e018f2 Correct a grammatical mistake: try and explain -> try to explain.
PR:		36462
Submitted by:	Gary W. Swearingen <swear@blarg.net>
2002-04-05 21:37:22 +00:00
Giorgos Keramidas
6ddd2cc0dc Fix &entities; that lacked an ending ';' character,
as reported by the following:

	% cd doc/en_US.ISO8859-1
	% find . -type f -name '*.sgml' |\
	  xargs grep '&[^[:space:];&][^[:space:];]*$' | grep -v '&$'
	% find . -type f -name '*.sgml' |\
	  xargs grep '&[^[:space:];&][^[:space:];]*[[:space:]<]' |\
	  grep -v '&[[: space:]]' | grep -v '[[:space:]]&&[[:space:]]'
2002-03-27 01:16:55 +00:00
Peter Pentchev
767c635e20 Whitespace-only fixups for the committers and lists entities conversion. 2002-03-15 07:57:16 +00:00
Peter Pentchev
eed41e97e6 Convert the names, descriptions and e-mail addresses of FreeBSD
committers and mailing lists to &a.xxx; entities.

Reviewed by:	keramida
Approved by:	keramida, silence on -doc
2002-03-15 07:46:22 +00:00
Murray Stokely
536cf1f77b Assume maintainership of the Developer's Handbook (was asmodai). I
have by far made the most commits to this document, and I have some
ideas about splitting out the kernel content into a seperate book.
The scope of this document is too large.
2002-03-13 07:04:12 +00:00
Chern Lee
08e753f4c4 Fix doc build, change deprecated use of <port> tag to
<filename role="package">
2002-03-06 02:22:35 +00:00
Murray Stokely
f65211b505 * Rework the beginning to remove duplicated information.
* Minor markup fix.
* Couple of grammatical/readability improvements.
* Mention that ddd is a port.

PR:		docs/34921
Submitted by:	Ceri <setantae@submonkey.net>
2002-03-05 15:45:36 +00:00
Murray Stokely
6e4faa49dc * Minor grammar fixes.
* Fix a couple of typos.
* <literal> -> <option> for maxusers.
* NOT -> <emphasis>not</emphasis>.
* Correct location of SoftUpdates readme.

PR:		docs/35108
Submitted by:	Ceri <setantae@submonkey.net>
2002-03-05 15:35:44 +00:00
Dima Dorfman
fcfccd4a32 <port>fish</port> -> <filename role="package">fish</filename>
Generated with:	s:<port>(.*?)</port>:<filename role="package">\1</filename>:g
2002-02-27 05:08:13 +00:00
Murray Stokely
6d7cfec6d8 "" -> <quote></quote>
Also, fix a typo.

PR:		docs/35089
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-19 14:34:11 +00:00
Murray Stokely
fdfdce0cb7 Grammar fixes.
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-19 14:26:36 +00:00
Giorgos Keramidas
5fb578f819 Chapter cleanup:
- Various grammar fixes.
- Change "ie." to "i.e."
- Convert quotes to <quote> or other more appropriate tags.

PR:		docs/34967
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-18 01:57:39 +00:00
Giorgos Keramidas
45f7d6cff8 Change <action> to <maketarget>.
PR:		34922
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-18 00:56:57 +00:00
Giorgos Keramidas
4e6b932de3 Now where did I put that ispell?
Fix typo introduced in last commit:
	priviledged -> privileged

Submitted by:	dannyboy
Pointy hat to:  keramida
2002-02-17 01:00:34 +00:00
Giorgos Keramidas
5c3012928b Various grammar, typo and syntax fixes.
PR:		docs/34916
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-16 23:35:35 +00:00
Giorgos Keramidas
830c679cc9 Add a <filename> missed in last commit. 2002-02-16 23:24:29 +00:00
Giorgos Keramidas
ab6fd7a72e Wrap filenames in <filename>.
PR:		docs/34916
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-16 23:14:05 +00:00
Giorgos Keramidas
50ce76a93c Replace quotes with more appropriate tags,
in preparation of applying other fixes.

Inspired by:    Ceri <setantae@submonkey.net>
2002-02-16 22:54:50 +00:00
Giorgos Keramidas
29fa736d61 Change "administrator commands" to "priviledged commands". 2002-02-16 22:28:08 +00:00
Giorgos Keramidas
45ddfacf00 Add missing fullstop.
Misc grammar fixes.

PR:		docs/34914
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-16 22:17:18 +00:00
Giorgos Keramidas
e7655d4598 Whitespace fixes.
Punctuation chars should not be preceded by spaces.
2002-02-14 22:31:00 +00:00
Giorgos Keramidas
c4d8816e3d Remove whitespace right before punctuation marks in running text. 2002-02-14 13:59:44 +00:00
Giorgos Keramidas
a81654a84a Change an inline URL to a <ulink>. 2002-02-14 13:57:32 +00:00
Giorgos Keramidas
c3bb194e6f Remove a pair of redundant <application> tags.
Split a long paragraph in two smaller ones.
Don't allow whitespace before ':' characters in running text.
2002-02-14 13:40:06 +00:00
Giorgos Keramidas
96d4dfa273 Add missing ; character after &prompt.root entities.
PR:		docs/34914
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-14 13:33:34 +00:00
Giorgos Keramidas
924220591d Syntax and grammar fixes.
PR:		docs/34913
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-14 13:20:33 +00:00
Giorgos Keramidas
4d513c74f1 Various utypo fixes.
PR:		docs/34912
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-13 23:49:11 +00:00
Murray Stokely
619cf2ffb4 * Do not claim that we ship the very latest version of Perl in the
base system.
* Update links to FreeBSD packages to use the 'Latest/pkgname.tgz'
  link so that we don't have to keep the version numbers updated.
* Expand some </> shorthand.
* Fix a few typos.

PR:		docs/34884
Submitted by:	Ceri <setantae@submonkey.net> (mostly)
2002-02-13 10:03:32 +00:00
Murray Stokely
79a0e7d83c * Note that src/crypto contains more than just DES stuff.
* Spell 'Kerberos' properly.
* Fix a few other typos.

PR:		docs/34883
Submitted by:	Ceri <setantae@submonkey.net>
2002-02-13 09:47:10 +00:00
Dima Dorfman
6268ceeea5 Demangle the definition of `struct jail'.
PR:		34640
Submitted by:	Stefan Farfeleder <e0026813@stud3.tuwien.ac.at>
2002-02-10 08:41:31 +00:00
Alexey Zelkin
cea4821669 add missing chapters to SRCS. Sort SRCS while I'm here 2002-01-30 14:18:23 +00:00
Murray Stokely
fe664eeac2 Fix some rather amusing typos.
Submitted by:	schweikh
2002-01-03 14:26:23 +00:00
Murray Stokely
6f26cb1384 Update copyright years. 2002-01-01 09:43:38 +00:00
Murray Stokely
c730fc3dfc Add a chapter about the internals of the Jail subsystem.
PR:		docs/32910
Submitted by:	Evan Sarmiento <evms@cs.bu.edu>
2002-01-01 09:33:44 +00:00
Murray Stokely
d9ba0513eb sysctl -w is deprecated.
Reminded by: des
2001-12-13 09:15:21 +00:00
Giorgos Keramidas
b1def32fd6 Expand all contractions in the developer's handbook. 2001-12-08 10:48:58 +00:00
Giorgos Keramidas
55f6bdd638 Add newline at EOF, where necessary.
Remove redundant whitespace at EOF.
2001-12-08 10:45:19 +00:00
Giorgos Keramidas
1867e747e4 Remove redundant EOF whitespace. 2001-12-08 10:42:00 +00:00
Murray Stokely
dd4e35d55c Add some information about breaking to the debugger from the command
line with :

  # sysctl -w debug.enter_debugger=ddb

PR:		docs/32483
Submitted by:	archie
2001-12-08 04:31:22 +00:00
Murray Stokely
14f3ecea08 Wrap author attributions in <chapterinfo> <authorgroup> .. 2001-11-23 19:25:57 +00:00
Murray Stokely
b292754c66 Whitespace change only - Fix the indentation to provide a better
example for future contributors.
2001-11-23 19:15:28 +00:00
Murray Stokely
7fe9c7b818 Add a chapter about writing device drivers for the sound subsystem.
Submitted by:	Jean-Francois Dockes <jean-francois.dockes@wanadoo.fr>
Reviewed by:	cg
2001-11-23 19:01:25 +00:00
Murray Stokely
cbaac8819e Catch up with the changes made to the Handbook makefile. Make the
index a parameter entity that is only included if -i chap.index is
added to the command line (handled automatically in the GEN_INDEX=true
case).
2001-11-19 06:23:41 +00:00
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
679f8542f7 Break a paragraph out into its own <sect1> to be orthogonal with the
rest of this chapter.

PR:		31983
Submitted by:	Jean-Francois Dockes <jean-francois.dockes@wanadoo.fr>
2001-11-14 17:18:12 +00:00
Chern Lee
fac4584d62 Reverse four instances in previous spelling-fix commit:
* out takes -> outtakes
 * blinking lights -> Blinkenlights
 * hard coding -> hardcoding
 * place holder -> place holder

Pointed out by: des
2001-11-05 19:13:01 +00:00
Chern Lee
fb68848e50 Spelling Fixes:
* loadded -> loaded
 * useability -> usability
 * idealogy -> ideology
 * manpages -> man pages
 * fucntion -> function
 * useable -> usable
 * nowehere -> nowhere
 * loger -> longer
 * mechanisim -> mechanism
 * staticly -> statically
 * seperatly -> separately
 * initilized -> initialized
 * priorites -> priorities
 * funtions -> functions
 * predeclard -> predeclared
 * fuction -> function
 * signalled -> signaled
 * keypresses -> key presses
 * devicere -> device
 * programing -> programming
 * begining -> beginning
 * hardcoding -> hard coding
 * outputing -> outputting
 * siginificant -> significant

And many other "theword" -> "the word" whitespace fixes in the usb chapter.
2001-11-01 00:22:20 +00:00
Chern Lee
cfb67e5b21 Add a $FreeBSD$ version tag. 2001-11-01 00:17:06 +00:00
Murray Stokely
bc83273cff * Correct some links
* Use ftp.hostname.com/directory rather than
  ftp.hostname.com:directory.
* s/freebsd.org/FreeBSD.org/
* Use relative links for FreeBSD.org documents

PR:		31447
Submitted by:	Cyrille Lefevre
Found by:	linbot
2001-10-23 21:54:19 +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
6feaaf16de Nested sect3's should be sect2, fixed. 2001-09-13 00:30:04 +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
Chern Lee
a9e41ae7ae Moved section on Programming I18N Compliant Applications from Handbook
to Developers Handbook.

Suggsted by: nik and murray
2001-09-13 00:14:45 +00:00
Murray Stokely
f586e47f10 Add some text to the "BSD Vision" and "Architectural Guidelines"
sections of this chapter.

Obtained from:	PHK's post to developers@ on 20 Nov 2000.
2001-09-03 00:19:18 +00:00
Murray Stokely
f1979ede58 Add a small chapter on the sysinit framework, linker sets, etc..
PR:		docs/30265
Submitted by:	Jason Smethers <jason@smethers.net>
2001-09-02 21:19:03 +00:00
Murray Stokely
14c1a08eed Briefly mention KDevelop as a free IDE available for FreeBSD. Also
update the verbiage about our Pascal support.

PR:		30110
Submitted by:	Rahul Siddharthan <rsidd@physics.iisc.ernet.in>
2001-09-02 09:24:05 +00:00
Murray Stokely
adc734089c Fix sloppy use of whitespaces inside a <programlisting>. While I'm
here, add the emacs local variables section to the bottom of this
file.

PR:		docs/30227
Submitted by:	Joseph Mallett <jmallett@xMach.org>
2001-09-02 09:02:29 +00:00
Murray Stokely
32c554e9bb Add a chapter on Kernel Objects. The content is rather limited right
now but there are several other texts that can be integrated into this
chapter.

PR:		27678
Submitted by:	Jason Smethers <jason@smethers.net>
2001-09-02 03:11:09 +00:00