Commit graph

304 commits

Author SHA1 Message Date
Joel Dahl
d5140b068d Improve wording and grammar.
Reviewed by:	brd
2006-06-16 20:47:14 +00:00
Konstantin Belousov
283f123ffc Document the procedure to obtain the debugging information
when the system deadlocks.

Approved by: pjd (mentor)
2006-06-13 10:48:58 +00:00
Vitaly Bogdanov
a5a24a7ca1 Bump copyright year 2006-03-25 09:51:13 +00:00
Xin LI
e140896ec8 Escape <, >, &'s, plus some cleanups against the SGML. There should not
be any content changes involved in this commit, however, localization
teams are encouraged to catch up with this change.

Requested by:	intron at intron ac
Reviewed by:	Niclas Zeising <lothrandil at n00b apagnu se>
Glanced by:	simon
2006-01-05 20:03:39 +00:00
Xin LI
bd9dc44478 Remove a duplicated "line". 2006-01-02 13:18:55 +00:00
Jesus R. Camou
0c5645526e Fix typo.
Noticed by:	ceri
Approved by:	trhodes (mentor)
2005-11-10 04:54:00 +00:00
Jesus R. Camou
1a115bf288 Update sockets.
PR:		docs/88507
Submitted by:	Ulf Lilleengen <lulf@kerneled.org>
Approved by:	trhodes (mentor)
2005-11-09 03:30:59 +00:00
Tom Rhodes
25d00cc4a6 Reword a paragraph to make it more clear,
Use &os; in place of FreeBSD,
Avoid "sexist" language.
2005-11-09 02:56:21 +00:00
Jesus R. Camou
191eead814 o Remove old <ulink> tags for packages. Use
<filename role="package"> instead.
o Add Ruby to the list of supported interpreters.

Recommended by:	trhodes
Approved by:	trhodes (mentor)
2005-11-09 02:43:26 +00:00
Joel Dahl
7c85bb5704 Remove KerberosIV from the src/ layout.
Approved by:	brueffer (mentor)
2005-09-05 18:03:52 +00:00
Giorgos Keramidas
70010d72ab Move rescue/ to the right place. Paths are sorted alphabetically. 2005-08-11 01:03:44 +00:00
Giorgos Keramidas
6368b6d37a Add a description of src/rescue to the layout of src/.
Submitted by:	Ulf Lilleengen <lulf@kerneled.org>
2005-08-11 00:59:28 +00:00
Marc Fonvieille
e98c98f0a9 Typo: s/herror/perror
Submitted by:	G. Adam Stanislav <adam@redprince.net>
2005-07-22 08:18:31 +00:00
Christian Brueffer
ec04638a2f dumpdir is correct here, not dumpdev.
PR:		81361
Submitted by:	Marius Nuennerich <marius.nuennerich@gmx.net>
2005-05-22 14:27:30 +00:00
Murray Stokely
865b53d924 Remove stub chapters that are relics of Jeroen's original proposal for
a Developer Handbook.

In 5 years we haven't had anyone contribute a chapter on Alpha
Assembly Language programming, Linux Compatability, Syscons, UFS,
AFS/NFS, or Signals.  If someone wants to in the future, great, but
there is no need for empty stub chapters anymore.

There are much better sources for this content in the D&I book and
Stevens' APUE.

Removing these stubs makes the content that we do have more apparent,
rather than focussing on what has yet to be written.
2005-05-04 14:56:08 +00:00
Murray Stokely
40c95a5807 Spellcheck. 2005-05-04 14:17:09 +00:00
Simon L. B. Nielsen
1caa123f8e Correct path to kernel.debug.
Submitted by:	yunweb@yunweb.homeunix.org
2005-05-01 08:23:12 +00:00
Jesus R. Camou
691421c7a8 Update a broken link. While in here, bump
the copyright year.

Noticed by: 	T.M. Sommers <tms@nj.net>
Approved by:	trhodes (mentor)
2005-04-24 23:23:55 +00:00
Marc Fonvieille
1d3fa1bf1e Add a missing word.
PR:		docs/79311
Submitted by:	Linus Nordberg <linus@nordberg.se>
2005-03-28 18:01:41 +00:00
Murray Stokely
53b85eb152 Reference the development.7 man page.
PR:		docs/62914
2005-03-18 02:16:39 +00:00
Tom Rhodes
991f86250f Add a note about what versions of FreeBSD use kgdb and what versions do not.
Suggested by:	simon
2005-03-01 07:00:29 +00:00
Remko Lodder
a71b558a75 s/FreeBSD-current/&os.current;/
s/transfered/transferred/ (correct spelling)

PR:		docs/78037
Submitted by:	Jesus R. Camou <jcamou at cox dot net>
Approved by:	simon (mentor)
2005-02-25 15:35:08 +00:00
Peter Pentchev
b8168a63b9 Fix a typo - 'ouput' -> 'output'.
PR:		78007
Submitted by:	"Jesus R. Camou" <jcamou@cox.net>
2005-02-24 13:21:55 +00:00
Tom Rhodes
c235a5efeb Update for reality: kgdb not gdb -k.
PR:	75536 and 72925
2005-02-24 04:45:43 +00:00
Simon L. B. Nielsen
ed68a6151d - Remove a few contractions.
PR:		docs/77778
Submitted by:	Joel Dahl <joel@automatvapen.se>
2005-02-20 14:53:33 +00:00
Simon L. B. Nielsen
3fe2ada25c Fixup of whitespace from last commit.
Translators can ignore this commit.
2004-12-12 12:29:42 +00:00
Simon L. B. Nielsen
e02a5ba50a Improve mark-up a bit:
- Use a manual page reference for gdb(1).
- Use <replaceable>.
- Do not embed <screen> sections in <para> sections.
2004-12-12 12:21:49 +00:00
Giorgos Keramidas
6c52523e6b Grammar nit.
Submitted by:	beowuff at gmail dot com
2004-12-09 11:45:37 +00:00
Ceri Davies
eb2cd84505 Internet Explorer fails to render some tables generated by the
informaltable element properly, unless the pgwide attribute is
explicitly set to 1.  Use this consistently within the (en) tree, and
update the FDP accordingly.  This should finally silence the demons in:

PR:		docs/73095
Submitted by:	Hilko Meyer <Hilko dot Meyer at gmx dot de>
2004-11-29 21:43:38 +00:00
Hiroki Sato
c4cb2201ad Use lower-case characters for attribute name (s/URL=/url=/).
No content change.
2004-08-09 19:49:18 +00:00
Hiroki Sato
5fa082b1f8 Simplify parameter entities in doctype declaration.
Currently we have articles.ent and books.ent, and
for example, articles.ent can be used by putting the
following lines in the doctype declaration:

 <!ENTITY % articles.ent PUBLIC
            "-//FreeBSD//ENTITIES DocBook FreeBSD Articles Entity Set//EN">
 %articles.ent;

This pulls all of the necessary entities via share/sgml/articles.ent.

The translation teams can customize these entities by redefining
the articles.ent file in <langcode>/share/sgml.  See
ja_JP.eucJP/share/sgml for example.
2004-08-08 13:44:01 +00:00
Denis Peplin
c12c11040e Use url entities for links between docs 2004-08-05 10:04:31 +00:00
Murray Stokely
d05594021a Add 'frame="none"' attribute to <informaltable>s. 2004-07-09 09:50:34 +00:00
Hiroki Sato
84f8ee0a15 Use relative URLs when URL_RELPREFIX is defined and URLS_ABSOLUTE
is not defined.

- URL_RELPREFIX must always point the top page's URL
  (http://www.FreeBSD.org) in relative form, defined in Makefile.

- &url.base; can be used in doc/<langcode>/*.  It will be
  replaced with the real URL which points the top page.

For translators: Please make sure to define URL_RELPREFIX to
point the top page.  The localized docs have different directory
hierarchy in its URL from the English version.

Tested by:	den
2004-07-06 15:09:55 +00:00
Josef El-Rayes
8142b0c275 Fix missing whitespace after 'Contributed by' and another minor
sgml issue i introduced with last commit.

Pointed out by:		simon
2004-05-16 21:44:47 +00:00
Josef El-Rayes
6d05c0410f Modify the author information into standard used through out the handbook.
Discussed on:	freebsd-doc@
2004-05-16 21:28:34 +00:00
Simon L. B. Nielsen
f8297243db This file was repo-copied from handbook/policies/chapter.sgml but
changes was done to the original after the repo-copy, so merge in
those changes (v. 1.21-1.28).  Since this file has also been changed
since the repo-copy the changes was merge in by hand, so it is not a
straight merge of the changes.

Note: This chapter seems seriously out-of-date.
2004-05-16 19:14:23 +00:00
Denis Peplin
bf2a771582 Use &url.main; for references to main FreeBSD website
Ihis entity auto-replaced with ../../../.. by default
and with http://www.FreeBSD.org/ when URLS_ABSOLUTE is set
(used for mirrors and for release building accordingly)
2004-05-11 13:29:48 +00:00
Hiten Pandya
aa1d79ded1 <ulink URL="xxx"> is wrong, change it to <ulink url="xxx"> 2004-03-20 22:55:03 +00:00
Marc Fonvieille
8fbfcf3c67 Update copyright to match recent changes.
PR:		docs/63579
Submitted by:	Jesus R.Camou <jcamou@cox.net>
2004-03-01 17:07:50 +00:00
Ceri Davies
d385af32a6 Correct instances of "try and ...". 2004-02-25 20:07:18 +00:00
Simon L. B. Nielsen
0b473c33aa *.sgml:
- Use trademark entities.
 - Add trademark attributions.
 - Don't join trademarks with other words, e.g. using hyphens.

trademark.ent:
 - Add trademark entity for Sun.
2004-02-16 00:11:08 +00:00
Simon L. B. Nielsen
1b0e3a763d Add a new chapter about "Regression and Performance Testing".
At the moment the main content is the Micro Benchmark Checklist posted
to -current by phk and expanded by rwatson.  The list did not really fit
in any of the current chapters, so a new chapter was created.  I hope
others can add more content to this chapter later.

Content by:	phk, rwatson
Reviewed by:	phk, josef
No objections:	-doc
2004-02-15 22:56:09 +00:00
Sean Chittenden
10be000a0a Update the section on debugging a kernel with GDB to include a recent
dump and the basics of what most developers would like to see in reports
of a panic where a dump is available.  Also trim a few lines from the
previous dump example (still included) and sync up some of the gdb
commands for the sake of consistency.

Inspired by:	Recent exchange with jhb
2003-12-04 01:46:33 +00:00
Ceri Davies
f62ed2d8ef Grammar police: "setup" is not a verb. 2003-11-05 10:50:51 +00:00
Sean Chittenden
8f608f949f Grammar, word, and phrasing updates as well as a few extra notes/tips here
and there regarding using a dumpdev/dumpdir to obtain crash information.
2003-10-22 22:53:41 +00:00
Sean Chittenden
6e1fe5cacb Revamp the first section regarding obtaining a kernel dump and bring the
instructions inline with reality (ex: savecore hasn't had the -N flag for
a while).  The verbage here should be sufficient for developers to be able
to point users on current@ to these first two sections and have them
extract something reasonably useful, esp now that -CURRENT no longer means
FreeBSD 3.1.
2003-10-18 00:48:15 +00:00
Sean Chittenden
4bea63b48e Nuke whitespace before running over this chapter in an attempt to update
various examples so that this chapter is useful to new and unsuspecting
vict^H^H^H^Huser^H^H^H^Hkernel debuggers.

Submitted by:	echo "(setq-default show-trailing-whitespace t)" >> ~/.emacs
2003-10-17 21:16:23 +00:00
Sean Chittenden
2c9abf4694 Whitespace changes in the sample .emacs file. 2003-10-17 21:09:05 +00:00
Marc Fonvieille
25eac97f02 Add a reference to the Free Pascal Compiler.
PR:		docs/56132
Submitted by:	Marco van de Voort marcov@stack.nl
2003-08-29 13:31:23 +00:00