os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
40753 commits 1 branch 79 tags 298 MiB
Commit graph

379 commits

Author SHA1 Message Date
Gabor Kovesdan
a06603e1e8 - MFH 2013-02-05 09:14:34 +00:00
Gabor Kovesdan
5df509eaa2 - Remove standalone="no" statements from XML declarations since it did not 
always work and is no use anyway
 2013-01-30 19:12:36 +00:00
Gabor Kovesdan
36cdb51546 - Migrate the documentation set to DocBook 4.5 2013-01-30 14:00:53 +00:00
Gabor Kovesdan
d95165dc16 - Make the English documentation valid XML 2013-01-21 17:37:33 +00:00
Eitan Adler
44d90126ab Recommit portions of r40117 which are still valid. Remove a ton of obsolete comments from the "developer's handbook". 
Approved by:	bcr (original commit)
 2012-11-26 03:00:20 +00:00
Eitan Adler
0f21e94e49 Revert r40117 which removed the last mention of the "old" way to build the kernel. This needs some reworking to explain why one would want to do this. 2012-11-26 02:58:34 +00:00
Eitan Adler
50c1259b80 Remove a ton of obsolete comments from the "developer's handbook". 
Approved by:	bcr (mentor)
 2012-11-21 13:57:13 +00:00
Isabell Long
2be1e25fc2 Replace 'SGML' with 'XML' in Makefile code and comments. A consequence of 
this was that 'SGMLFLAGS' had to be changed to 'XMLFLAGS' in
share/mk/doc.docbook.mk so that everything continued to build OK.

Approved by:	gabor (mentor)
 2012-10-06 17:52:37 +00:00
Isabell Long
2498002187 Add a new section to the developer's handbook about kernel debugging with 
Dcons.

Converted from the wiki page [1] by myself as part of Google Code-In 2011.

[1] http://wiki.freebsd.org/DebugWithDcons

Reviewed by:	gavin
Approved by:	gabor (mentor)
 2012-10-04 11:04:11 +00:00
Gabor Kovesdan
77d737ee88 - Rename the share/sgml directories to share/xml 
- Fix build errors from the next change

Approved by:	doceng (implicit)
 2012-10-01 11:56:00 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml 
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
 2012-10-01 09:53:01 +00:00
Gabor Kovesdan
efe7023c1f - Encoding names should be IANA names and in lower case 2012-09-22 20:09:08 +00:00
Gabor Kovesdan
9c243757ef - XML declarations should use IANA encoding names 
Pointed out by:	hrs
 2012-09-14 17:47:48 +00:00
Isabell Long
2e9319a593 Remove an extra word and place a full stop (period) inside parentheses in 
the Emacs section of the Developer's Handbook.

Approved by:	gjb (mentor)
 2012-09-14 17:09:52 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces 
Approved by:	doceng (implicit)
 2012-08-21 19:16:02 +00:00
Gabor Kovesdan
7ba98a21ad MFH 
Approved by:	doceng (implicit)
 2012-08-19 23:05:52 +00:00
Gabor Kovesdan
74586f38c6 - Remove PSGML comments since they are not very useful after the XML 
migration

Approved by:		doceng (implicit)
No objection from:	doc@, www@
 2012-08-07 23:31:39 +00:00
Isabell Long
e5c7e3910a Describe remote GDB configuration in greater depth in the developer's handbook. 
PR:		docs/170013
Submitted by:	Carl Delsey (carl.r.delsey (at) intel.com)
Reviewed by:	gavin
Approved by:	gjb (mentor)
 2012-07-20 14:46:08 +00:00
Isabell Long
564efa1a3f Remove outdated information from the Emacs section of the developer's 
handbook.

PR:		docs/160447
Submitted by:	radiomlodychbandytow [at] o2 [dot] pl (on the mailing list;
		PRed by gjb)
Reviewed by:	gjb
Approved by:	gabor (mentor)
 2012-06-28 09:10:37 +00:00
Gabor Kovesdan
3cdf4e4922 - XMLify English books 
Approved by:	doceng (implicit)
 2012-06-21 16:04:40 +00:00
Warren Block
1c3a3f8502 Whitespace-only changes. Fix indentation, trailing whitespace, 
blank lines, rewrap paragraphs.
 2012-04-02 15:42:38 +00:00
Glen Barber
d45961b7f6 Rewrap a few paragraphs 
Found with:	textproc/igor
 2012-02-21 04:01:43 +00:00
Glen Barber
ee0fa2683e Add commas after 'e.g.' 
Fix a grammar nit: s/test/testing/

Found with:	textproc/igor
 2012-02-21 03:59:33 +00:00
Glen Barber
a557e8e13e Document the FreeBSD src Tinderbox from the FreeBSD wiki. 
This work was done as part of Google Code-In (GCIN) 2011.

GCIN student:		Isabell Long (isabell121 gmail com)
GCIN task mentors:	des, gjb
Minor changes by:	gjb
 2012-02-19 00:59:04 +00:00
Ryusuke SUZUKI
3dbe1e3852 PR: docs/159650 
Update the description about the dumpdev variable in rc.conf.

Reported by:	Jeremy Chadwick <freebsd _at_ jdc dot parodius dot com>
Reviewed by:	bcr, wblock, freebsd-doc
 2012-01-20 15:56:00 +00:00
Benedict Reuschling
1046ce0db1 Mention style(9) as an important guideline for FreeBSD development 
and provide links to STYLE.MAKEFILE(5).

PR:			docs/160696
Submitted by:		radiomlodychbandytow at o2 dot pl
Discussed on:		freebsd-doc
^M removal help by:	gjb
 2011-10-17 18:10:51 +00:00
Rene Ladan
614a27171c Remove lang/gpc as a Pascal compiler 
PR:		docs/156309
Submitted by:	Chris Rees [utisoft gmail.com]
 2011-04-12 18:21:40 +00:00
Alex Dupre
c0b6644e0c Fix 'ddd' command-line parameters for kernel debug. 
PR:		docs/127253
Submitted by:	Fritz Katz <frtzkatz@yahoo.com>
 2010-12-02 14:53:45 +00:00
Benedict Reuschling
9c4c826a5f Remove two sections about kerneldebugging (post mortem analysis and 
loadable modules using gdb) because the steps described in them are
not necessary anymore for quite a long time.

A rewrite would be in order, but since this goes beyond the scope of
the PR, I'll just remove them for now.

PR:             docs/143342
Submitted by:   trasz@
Reviewed by:    jhb@ via trasz@
 2010-09-19 18:15:03 +00:00
Johann Kois
140c1114ea PR: docs/149315 
Fix a typo.

Contributed by: olgeni@
 2010-08-10 20:40:36 +00:00
Johann Kois
9024e5e4a5 PR: docs/149315 
Fix a couple of typos/misspellings in:

- doc/en_US.ISO8859-1/books/corp-net-guide/book.sgml
- doc/en_US.ISO8859-1/books/dev-model/book.sgml
- doc/en_US.ISO8859-1/books/developers-handbook/l10n/chapter.sgml
- doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
- doc/en_US.ISO8859-1/books/porters-handbook/book.sgml

Contributed by: Jimmy Olgeni (olgeni@)
 2010-08-08 13:54:36 +00:00
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