Commit graph

348 commits

Author SHA1 Message Date
Xin LI
678c2ebdd3 ministat has been promoted as ministat(1). 2010-05-31 07:57:48 +00:00
Giorgos Keramidas
0402e26824 Mark "RCS" as an acronym and add a 'role' attribute wit its expansion
This may help a bit when people are not familiar with the specific
meaning of RCS we are alluding to in the dev handbook.

Triggered by:	A discussion with other doc-people
	  	and Walt Pawley, walt at wump.org.
2010-05-07 06:33:09 +00:00
John Baldwin
52598bce15 Correct syntax for branding an ELF executable as using the Linux ABI.
Submitted by:	Roy Nicholson  nicholson.roy at gmail
2010-02-17 18:20:32 +00:00
Peter Pentchev
d6ce8f3c55 Update the information about Perl and Tcl available in the ports tree.
PR:		140568, 140569
Submitted by:	Denny Lin <dennylin93@cnmc32.hs.ntnu.edu.tw>
2009-11-25 10:28:55 +00:00
Marc Fonvieille
4ab9f37ef9 Fix broken link.
Spotted by:	Glen Barber <glen.j.barber@gmail.com>
PR:		docs/136681
2009-07-13 07:37:11 +00:00
Gabor Kovesdan
9948e825ef - Add some hints to reduce strings to localize when using NLS
Reviewed by:	rene
2009-04-29 17:46:49 +00:00
Gabor Kovesdan
ac9abd3ad2 - Add a section about using POSIX NLS to internationalize programs
Reviewed by:	rene, rwatson
2009-03-21 02:38:53 +00:00
Chin-San Huang
a13098441e - Update the URL of nasm. 2009-02-01 21:41:26 +00:00
Murray Stokely
cce21e8660 The config dump syntax for hard-coding the dump location before
dumpon(8) can be executed has been deprecated since FreeBSD 4.x and no
longer works.  Use the loader instead.

PR:    	       docs/129263
2008-12-15 01:04:07 +00:00
Gabor Pali
6d34582484 - Generalize concept of repository, remove "CVS" from the wording 2008-11-18 07:32:15 +00:00
Gabor Pali
d10e06baff - Document directory "cddl" for utilities covered by the Common
Development and Distribution License

PR:		doc/128563
Submitted by:	Steven Kreuzer <skreuzer (at) exit2shell (dot) com>
2008-11-18 07:23:45 +00:00
Gabor Pali
2fba7a1743 Change markup of "<stdio.h>" (in the C example) from <sgmltag> to &lt;
and &gt; entities because "stdio.h" is not an SGML tag (a semantical
correction)
2008-10-16 05:23:15 +00:00
Gabor Pali
31e4e288c5 Bump copyright year of the Developers' Handbook due to several content
changes back in 2007 (e.g. [1], [2]) and 2008 (e.g. [3], [4], [5])

[1] http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/developers-handbook/ipv6/chapter.sgml?rev=1.19;content-type=text%2Fx-cvsweb-markup
[2] http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/developers-handbook/kerneldebug/chapter.sgml?rev=1.75;content-type=text%2Fx-cvsweb-markup
[3] http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/developers-handbook/secure/chapter.sgml?rev=1.29;content-type=text%2Fx-cvsweb-markup
[4] http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/developers-handbook/book.sgml?rev=1.56;content-type=text%2Fx-cvsweb-markup
[5] http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml?rev=1.35;content-type=text%2Fx-cvsweb-markup
2008-10-16 05:17:06 +00:00
Giorgos Keramidas
cb81fb3591 Various dev-handbook updates:
1. Mention src/MAINTAINERS and how it works.
2. Add a short suggestion about how to identify possible
   maintainers, inspired by the committers-guide
3. Tcl has been removed from the base distribution, so it does
   not really serve as a good example of contributed software any
   more (obsoletes docs/50735)
4. Mention the growing use of FREEBSD-Xlist files for contrib software
5. Describe how vendor imports of Subversion code can be done (inspired
   by the Subversion docs of the Wiki).
6. Use slightly more up to date release numbers when describing library
   version bumps.

Submitted by:   Gavin Atkinson <gavin@freebsd.org>
Patches by:     gavin, pgj, keramida
PR:             docs/126030
2008-08-31 13:04:12 +00:00
Gabor Pali
d67493361d - Take the outdated sections of articles/contributors out of circulation
in doc/

Discussed with:	joel
Reviewed by:	joel
Approved by:	gabor (mentor)
2008-08-16 21:42:36 +00:00
Gabor Pali
7b03a5b944 - Remove the chapter on DMA from FreeBSD Developers' Handbook since it
is no longer valid, however there could be added a new chapter on
  busdma [1] instead of this one

[1] http://www.freebsd.org/projects/busdma/

PR:		docs/126146
Discussed with:	jhb
Submitted by:	gavin
Approved by:	gabor (mentor)
2008-08-10 00:20:27 +00:00
Gabor Pali
edafad6a69 Eliminate erroneous role="directory" attributes from <filename> elements
and replace them with class="directory" [1][2]

[1] http://docbook.org/tdg/en/html/filename.html
[2] http://www.freebsd.org/doc/en/books/fdp-primer/sgml-markup-docbook.html#AEN1799
    (4.2.5.5)

Approved by:	trhodes, gabor (mentor)
2008-08-06 22:03:50 +00:00
Gabor Pali
002b4edbbe Change role="port" to role="package" so that package links are properly
generated

Approved by:	trhodes, gabor (mentor)
2008-08-06 20:44:12 +00:00
Daniel Gerzo
c3a59abed8 - Include string.h to avoid compile warning about using bzero without
defining it
- use herror() rather than perror() to give useful error messages
  (the *hostby*() functions set h_errno not errno)

PR:		docs/126031
Submitted by:	gavin
2008-08-03 09:50:20 +00:00
Gabor Pali
bf1ce11401 - A couple of updates to the "Secure Programming" section of the
developers handbook

PR:		docs/125485
Submitted by:	gavin
Reviewed by:	trhodes, gabor, Ben Kaduk <minimarmot (at) gmail (dot) com>
Approved by:	gabor
2008-07-23 21:40:57 +00:00
Gabor Pali
48c74ccc11 - Update to the tools section of the developers-handbook
PR:		docs/125346
Submitted by:	gavin
Reviewed by:	danger, trhodes, Ben Kaduk <minimarmot (at) gmail (dot) com>
Approved by:	trhodes
2008-07-23 20:39:55 +00:00
Remko Lodder
eb4bf0ee8d Cleanup information that is no longer actual and does not need replacement.
PR:		125861
Submitted by:	gavin
2008-07-22 16:46:34 +00:00
Martin Wilke
fbcf1f161e - The headline of chapter 10 has a typo, it should read "Building ..."
PR:		125486
Submitted by:	Philip Schulz <phs@deadc0.de>
2008-07-10 22:14:48 +00:00
Robert Watson
d29331a2ea Textdumps have been merged to RELENG_7, and so should appear in 7.1 and
higher.
2008-04-11 08:11:08 +00:00
Christian Brueffer
bee89619f0 Don't claim that Perl and Fortran are in the base system, add a note
about the next section describing some of the options from the ports
collection.

PR:		120152
Submitted by:	Michael Voorhis <mvoorhis@cs.wpi.edu>
2008-02-03 18:26:28 +00:00
Tom Rhodes
7738652c36 Replace 'debug.debugger_on_panic=1' with 'debug.kdb.enter=1' which actually
exists.  Add a note on forcing a panic using 'debug.kdb.panic=1'.

PR:	111781
2008-01-22 17:47:05 +00:00
Robert Watson
21c0c8925b Mention full memor dumps, minidumps, and textdumps in the introduction
to kernel debugging, with consequences for debugging.

Mention that the default in more recent FreeBSD versions is to
automatically select a swap partition and use it as a dump partition,
and don't suggest changing the default.

This chapter could use rather serious updating.
2007-12-26 12:56:46 +00:00
Chin-San Huang
9ada876c91 - Tweak quality.
Obtained from:	The FreeBSD Traditional Chinese Project
2007-09-28 16:05:30 +00:00
Remko Lodder
d187f07300 Update the design and implementation book to the one that Marshall wrote
with George.

Requested by:	gnn (on doc@)
2007-09-20 11:56:52 +00:00
Remko Lodder
8f74bea0d8 Add missing ).
Submitted by:	Hagen Kuehl
Requested by:	miwi
2007-08-04 08:11:40 +00:00
Doug Barton
8a313d7dcb Remove all references to the now-defunct 6bone [1]
Replace 3ffe:* (6bone) prefixes with the prefix reserved for documentation
in RFC 3849 (while I'm here).

Prompted by:	paul beard <paulbeard@gmail.com> [1]
2007-04-26 20:27:03 +00:00
Ken Smith
f11bbbf58d Fix minor typo. 2007-02-28 18:21:29 +00:00
Ken Smith
eab3576c54 Use of the easy-import tool is no longer suggested (and it's actually
now a shell script that tells you to use something else, that something
else being a tool to create new ports).

Confirmed by:	peter
2007-02-28 18:12:22 +00:00
Marc Fonvieille
75131fca35 Add a missing P in a kernel option
PR:		docs/108270
Submitted by:	Micah <micahjon@ywave.com>
2007-01-23 17:52:10 +00:00
Robert Watson
2ce1741cd1 Correct spelling of "show alllocks" from "show all locks".
Submitted by:	Ben Kaduk <minimarmot@gmail.com>
2007-01-02 19:02:00 +00:00
Robert Watson
286446c1d8 Correct some minor spelling and content errors in the remainder of the
kernel debugging chapter that I noticed while adding the glossary.
2006-12-31 14:27:17 +00:00
Ceri Davies
403d49b0c2 Correct minor typos. 2006-12-31 12:23:45 +00:00
Robert Watson
06360975af Add a glossary of compile-time kernel debugging options. 2006-12-31 11:24:34 +00:00
Daniel Gerzo
908d7e6654 - remove useless chapter Makefile
- add kernelbuild/chapter.sgml to the main Makefile

Approved by: keramida (mentor)
2006-10-18 19:34:16 +00:00
Daniel Gerzo
b5a92a5409 - remove "traditional" way of building kernel and add it to the
developers' handbook instead

Approved by: keramida (mentor), trhodes (mentor)
2006-10-16 19:15:36 +00:00
Marc Fonvieille
e13bdf2a4b Various typo and punctuation fixes. 2006-08-28 18:59:16 +00:00
Tom Rhodes
17ff867e1c Change "option" to "options" since we have two.
Fix options list to those in the manual page.
Fix description of "continue."
2006-07-16 18:41:52 +00:00
Tom Rhodes
cc2a284275 MFp4: Bring the kernel debugging section up to reality.
Requested by:	rwatson
2006-07-12 02:18:19 +00:00
Xin LI
ff35067906 Fix the link "Prev" on the top of index page of Developers' Handbook.
PR:		docs/99842
Submitted by:	intron <intron at intron dot ac>
2006-07-07 08:31:43 +00:00
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