Commit graph

54 commits

Author SHA1 Message Date
Warren Block
21115a05b8 Restore lost <replaceable> tags. 2014-04-28 20:13:07 +00:00
Gabor Kovesdan
24d129e8d1 - Definitively upgrade to DocBook 5.0 2013-11-07 15:39:28 +00:00
Warren Block
f99f3e141e Whitespace-only fixes. Translators, please ignore. 2013-07-24 03:00:29 +00:00
Gabor Kovesdan
adbdb3187f - Whitespac changes; translators may ignore 2013-07-23 19:21:07 +00:00
Gabor Kovesdan
736c0caff1 - Fix misplaced indexterms. 2013-07-23 18:55:22 +00:00
Gabor Kovesdan
a06603e1e8 - MFH 2013-02-05 09:14:34 +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
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
9c243757ef - XML declarations should use IANA encoding names
Pointed out by:	hrs
2012-09-14 17:47:48 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces
Approved by:	doceng (implicit)
2012-08-21 19:16:02 +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
Gabor Kovesdan
3cdf4e4922 - XMLify English books
Approved by:	doceng (implicit)
2012-06-21 16:04:40 +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
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
Gabor Pali
6d34582484 - Generalize concept of repository, remove "CVS" from the wording 2008-11-18 07:32:15 +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
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
Denis Peplin
c12c11040e Use url entities for links between docs 2004-08-05 10:04:31 +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
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
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
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
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
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
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
3e8d98b70a Standardize:
TCL -> Tcl
ethernet -> Ethernet
ftp (noun) -> FTP

Approved by:	murray
2001-07-17 22:20:51 +00:00
Chern Lee
66585ffb37 Add indexterms to policy chapter.
Contributed by Valentino Vaschetto <logo@blackened.com>
2001-07-13 22:21:27 +00:00
Nik Clayton
4e521b8bb2 Makefile's to make it easy to build individual handbook chapters. These
are *not* recursed in to by the top level Makefile.
2001-06-30 14:55:40 +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
Chris Costello
8f61bed60b Properly capitalize section <title> tags. 2000-08-20 17:18:43 +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
3302fdee27 Change &ldquo;...&rdquo; to <quote>...</quote> as per a discussion on
-doc.

Suggested by:	nik
2000-06-08 01:56:23 +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
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
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
10b0b0a21e Add SGML comments at the top of the files with the $Id$ string. Remove
most of the other spurious comments.

Two comments relating to copyright have *not* been merged in from the
LinuxDoc version yet -- I've contacted the original authors to ask if
they would be willing to assign the copyright to the project. When I
get their response the copyright comments will either be merged in, or
left out, as necessary.
1999-03-08 22:04:49 +00:00
Nik Clayton
1e28ab5a96 Huge whitespace changes. Translators can ignore this commit completely.
Rationale: All the changes to the DocBook handbook so far have been
careful to keep whitespace changes to a minimum. This is so the
translators have as easy a job as possible in identifying exactly what's
changed.

This has meant the English version has become more and more 'ugly'. Lines
indented by the wrong amount, some lines longer than 130 characters,
others shorter than 20, gaps of 3 or 4 lines between paragraphs (and
sometimes within paragraphs). This makes it difficult to follow the
structure of the document, and needlessly complicates fixing SGML
problems.

It also makes the source practically useless as a teaching aid; the
more baroque the source looks, the less likely people are to dive in and
contribute.

This commit fixes all that -- and boy was it tedious. The snag is, it's
touched almost every line in every file in the Handbook.

Technically, the changes were made by running (in Emacs)
sgml-indent-or-tab (bound to the TAB key) on almost each line (except
those in <programlisting>, <screen>, <literallayout>, and other
verbatim sections), and then running sgml-fill-element (bound to
C-c C-q) on most paragraphs.

FWIW, this is the first, only, and last change of this type contemplated.
1999-03-07 21:26:43 +00:00
Nik Clayton
fe79ecbe4d Revert one of my previous changes. Sentences now have two spaces after
the period. Apologies for the repository bloat. This is entirely a
whitespace change.
1999-03-04 22:42:55 +00:00