Commit graph

486 commits

Author SHA1 Message Date
Nik Clayton
6f6bb9b369 Use doc.project.mk, and ${.CURDIR} 1999-09-03 17:40:54 +00:00
Nik Clayton
cecc348da3 Use the new doc.project.mk file, and ${.CURDIR}. 1999-09-03 17:40:13 +00:00
Nik Clayton
743ed16724 Actually inform the user when the floppy has been unmounted in the
sample script.

PR:             docs/13384
Submitted by:   Nestor Calvo <ncalvo@es.freebsd.org>
1999-09-03 17:27:55 +00:00
Nik Clayton
20f7d377d1 Use doc.project.mk in place of docproj.docbook.mk.
Use the new ROOT_SYMLINKS variable where necessary.
1999-09-03 17:24:47 +00:00
Nik Clayton
30bff5e9ff A new chapter that explains the structure of the doc/ tree and how
documentation is placed under it.  Replaces the empty FAQ section and the
only partly completed Handbook section.  This is because the information
in here applies to all the documentation under doc/, not just the Handbook.

Move the style guide information out of the-handbook/chapter.sgml and in
to writing-style/chapter.sgml.  It doesn't really belong here either, but
we don't have a general style chapter (yet).

Update Makefile to know about this, and use the doc.project.mk file.

Update book.sgml to know about the new chapter.

Remove the old chapters.
1999-09-03 17:22:43 +00:00
Nik Clayton
52eba2b89b Mention where freebsd.dsl can be found. 1999-09-03 17:17:33 +00:00
Nik Clayton
97fe3901a9 Miscellaneous small changes. Includes reformatting white space in some
of the example HTML and DocBook fragments, which are significant.

Explain where to find the FreeBSD DTD that extends DocBook.

Add a section explaining about books and articles, and the differences
between them.

Added an example of <procedure>.

Be consistent with the white space inside <programlisting>.  Make sure
that content starts immediately after the opening tag.  Shouldn't make
a great deal of difference, but we should practice what we preach.

Remove the information about <informalexample>, as it seems to be
redundant, and we don't use it anymore.

Correct an error ("]]", should be "]") in the example of including the manual
page reference entities.
1999-09-03 17:16:06 +00:00
Nik Clayton
f4ca19b7a8 Miscellaneous small changes.
Note:  includes whitespace changes.  No active translations of this
document exist, so this doesn't matter.
1999-09-03 17:14:12 +00:00
Nik Clayton
9d22e6e5d7 "efficient" -> "more efficient". 1999-09-03 17:13:26 +00:00
Nik Clayton
fd86fdc323 List the new committers guide.
List "new-users" in ROOT_SYMLINKS, so it will get included in the top
level as necessary.

Use doc.project.mk in place of docproj.docbook.mk.
1999-09-03 17:11:28 +00:00
Nik Clayton
5f291ead9b The FreeBSD New Committer's Guide. The original text version was worked
on by many people, the SGML conversion has been carried out by the new(ish)
committer, John Baldwin.  Cheer's John.

Changes from the submission:

  1.  It's an article, not a book.  I originally thought there was going
      to be sufficient content (when you include the committers rules
      that are being thrashed out at the moment, and Satoshi's ports
      committer stuff) to make this worth being a book.  After seeing the
      content I changed my mind, so it's an article.

  2.  Various contractions ("you're" and so on) expanded to make life
      a little easier for the translators.  Kept one ("Who's Who").
1999-09-03 17:10:42 +00:00
Alexey Zelkin
acb04f3d78 Add myself to commiters section.
Reviewed by:	mpp
1999-09-03 05:33:48 +00:00
David E. O'Brien
91e4eb74ff Some TAB hating editor (emacs?) spammed the 4000XX __FreeBSD_version
section by using pure spaces rather than the established style
of <TAB><TAB><sp><sp><sp><sp>.
1999-09-02 18:05:37 +00:00
David E. O'Brien
66c6ce6f0a Correct the "newbus" __FreeBSD_version entry. (__FreeBSD_version actually
was not bumped after the newbus import. :-( [shame on them].
So I moved it to the ceiling of the closest value.  What was claimed to be
the __FreeBSD_version for "newbus" is really for "__deregister_frame_info
dynamic linker bug fix" and EGCS import.

Add 3.3 and 3.2 RELEASE's __FreeBSD_version values.

Obtained from:	cvs log src/sys/sys/param.h
1999-09-02 17:51:11 +00:00
Chris Costello
99c9241681 Add trailing `/' (slash) to URLs.
PR:		docs/13348
Submitted by:	Rich Wood <rich@FreeBSD.org.uk>
1999-08-31 19:58:35 +00:00
Jun Kuriyama
da4bea1cab We have used ${VAR}, not $(VAR ) . :- ) 1999-08-31 14:59:48 +00:00
Satoshi Asami
4b2e4fe173 $Id$ -> $FreeBSD$ in contents (mostly sample Makefiles).
Note I didn't touch the $Id$ line for the sgml file itself, I'm assuming Nik
or someone is going to convert all the doc files in one pass.
1999-08-31 11:34:17 +00:00
Joseph Koshy
120dadff23 Typo fix.
PR:		docs/13490
Submitted by:	Peng HaiJie <phj@cn.FreeBSD.org>
1999-08-31 10:33:26 +00:00
John Baldwin
6c26ae8336 Fix a broken tag. </para> -> </title>
PR:		docs/13465
Submitted by:	Mark Ovens <mark@ukug.uk.freebsd.org>
1999-08-30 11:53:03 +00:00
Joseph Koshy
854403a247 New FAQ entry on how to allow users to mount devices.
Reviewed by:	-doc (content), nik (DocBook expertise)
1999-08-30 05:33:19 +00:00
John Baldwin
7c3a7085f5 Fix a mistyped tag: <row> -> </row>
PR:		docs/13457
Submitted by:	jack@germanium.xtalwind.net
1999-08-29 18:31:09 +00:00
John Baldwin
cd08f5c92f Lots of [fF]ree(bsd|BSD).(org|ORG) -> FreeBSD.org fixups.
A few doc@FreeBSD.org -> freebsd-doc@FreeBSD.org fixes.

One freebsd -> FreeBSD name fix.

Reviewed by:	nik
1999-08-29 16:08:47 +00:00
Brian Feldman
efb2b82b9f Update for 320002. 1999-08-29 14:10:04 +00:00
John Baldwin
9c6e695ef1 Make the doc/en_* makefiles repect ${DOC_PREFIX} when they include
${DOC_PREFIX}/share/mk/docproj.docbook.mk instead of using hard-coded
paths.

Reviewed partially by:	nik, billf
1999-08-29 00:02:23 +00:00
John Baldwin
81fb662a55 FreeBSD.ORG -> FreeBSD.org for the MAINTAINERS e-mail address.
Translators can ignore this commit.

Reviewed by:	billf, nik
1999-08-28 19:49:39 +00:00
Jim Mock
a99dcb84c0 Add Yin-Jieh Chen for the icqnix port. 1999-08-28 03:02:06 +00:00
Mark J. Taylor
6647e72130 Add myself to the list of committers. 1999-08-27 15:40:37 +00:00
Jim Mock
5af0c18496 Added Egeny Kuzakov <CoreDumped@lab321.ru> for the tircproxy port. 1999-08-26 23:43:50 +00:00
Chris Piazza
db46587229 Add Chris D. Faulhaber <jedgar@fxp.org> for the p5-IRC port 1999-08-26 20:41:45 +00:00
Nik Clayton
5d61c67118 When making the compatability symlink, do it in the parent directory
to both directories, and make it relative, rather than absolute.

This fixes the case where you might install the docs under one directory
/foo/bar/..., and then want to migrate them elsewhere (to /usr/share/).

With the old scheme, the symlink would start /foo/bar/..., and would
therefore be broken.

A good example of this happening is "make release" :-)
1999-08-26 19:42:13 +00:00
Mark J. Taylor
8ff3d7886a Add myself to the list of committers. 1999-08-25 20:38:52 +00:00
Nik Clayton
5ec01e841f Change the internal links to use <link ...> rather than <xref ...>.
This stops the (non-fatal) errors, and generates useful links.

PR:             docs/13349
Submitted by:   Neil Blakely-Milner <nbm@rucus.ru.ac.za>
1999-08-24 19:05:16 +00:00
Nik Clayton
1ca335c3e7 "is is" -> "it is"
Submitted by:   Kelly Yancey <kbyanc@posi.net>
1999-08-24 19:01:16 +00:00
Chris Costello
e5ebbaedba Cosmetic: <ulink URL=...' -> <ulink url=...' according to the doc proj
primer.
1999-08-24 13:20:40 +00:00
Joseph Koshy
613d6c2cc6 Make the question I added on TERM mismatches when logging onto remote systems
clearer.
1999-08-24 08:54:28 +00:00
Chris Piazza
a938e63860 Re-remove Chris Costello from additional contributors: he's
a committer now.
1999-08-24 06:14:33 +00:00
Joseph Koshy
ecdbbeb3a7 Add a few people to the additional contributors section:
Rich Wood   <rich@FreeBSD.org.uk>    for docs/13336
    Chris Costello <chris@calldei.com>   for docs/12990
    Kiril Mitev <kiril@ideaglobal.com>   for docs/12985
1999-08-24 06:03:34 +00:00
Joseph Koshy
2371fff5df Add trailing slashes to URLs.
PR:		docs/13336
Submitted by:	Rich Wood <rich@FreeBSD.org.uk>
1999-08-24 05:01:13 +00:00
John Baldwin
60b17bf4c3 Move myself from the contributors list to the committers list in the
handbook.

Reviewed by:	billf
1999-08-24 03:22:22 +00:00
Chris Piazza
38949d4e41 Fix a typo (accellerator -> accelerator) and a missing space.
PR:		13208
Submitted by:	Mark Ovens <mark@ukug.uk.freebsd.org>
1999-08-24 02:35:59 +00:00
Nik Clayton
122d319794 "../handbook.sgml" -> "../book.sgml" in Emacs local variables section. 1999-08-23 21:24:10 +00:00
Nik Clayton
4e9bf8757d "../handbook.sgml" -> "../book.sgml" in Emacs local variables section.
Fix up the list of questions and answers as a <qandaset> instead of
an <itemizedlist>.  This entails converting the <itemizedlist> element
to a <qandaset>, and wrapping each question paragraph in a <question>
and </question> pair, and each answer in a <answer>...</answer> pair.

Then, search and replace for all the "Q.  " and "A.  " and remove them,
because the stylesheet adds these for you.

Finally, some of the questions are entered as

    <para><anchor id="foo">...

Delete the anchor element, and put the id attribute on the para instead,
so you have

    <para id="foo">...

I'm not entirely sure why, but if you have that in the first form then
the stylesheets don't include the links properly in the table of
questions.  If you have it in the second form then everything works fine.
1999-08-23 21:06:02 +00:00
Chris Piazza
206fa161b0 Add Dominik Rother for the xtermset port and
KATO Tsuguru for an upgrade of the blackbox port
1999-08-22 04:30:18 +00:00
Nik Clayton
a3163ec304 Honour ${DOCDIR} when installing the documentation. 1999-08-19 20:36:02 +00:00
Nik Clayton
b797b99689 Markup the preface as a <preface> rather then a <chapter>.
The first question in the preface, "What is the purpose of this FAQ"
doesn't need to be there (although the contents of the answer do).  Remove
the question, and associated markup, but retain the answer.
1999-08-18 19:16:52 +00:00
Nik Clayton
67ed80c4ec Update the list of ports categories.
PR:             docs/13214
Submitted by:   asami
1999-08-18 18:58:10 +00:00
Nik Clayton
5f5aae5fd7 Add Daisuke Watanabe (www/p5-Apache port fix)
PR:             docs/13213
Submitted by:   asami
1999-08-18 18:51:30 +00:00
Nik Clayton
837580be8b Turn on the faq/ directory. 1999-08-17 22:11:19 +00:00
Nik Clayton
6d73649fa3 Framework to build the DocBook FAQ. 1999-08-17 21:52:02 +00:00
Nik Clayton
35d121c7b7 DocBook version of the FAQ, first draft. 1999-08-17 21:47:46 +00:00