Submitted by: me
Reviewed by: nik
Correct some problem in FAQ, after nik's New make(1) infrastructure committed.
These changes are:
1. "Q:Q:" link of FAQ html file is wrong, so change <xref...> to <link ...>.
2. In the Chapter 9, Networking section, there is a wrong link too: GaTeD
has a new location now.(http://www.gated.org/).
3. Fix a weird <email>@</email> tag, It looks like we just need a single
"@" but not to mail somebody anonymous. I proposed to use
<emphasis remap=tt><@></emphasis> instead of <email>@</email>.
4. Use <address> .... </address> as nik's sugggestion.
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.
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.
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").
of smaller doc.<foo>.mk files, reflecting the functionality they contain.
Long overdue, kudos to the submitter for the carrying out the work.
Also makes the files independent of the system include files that
normally live in /usr/share/mk, making it easier for non-FreeBSD systems
to download and build our docs (an important factor in making it easier
to share our work with other projects).
Finally, it (in theory) lets you build the docs with a r/o doc/ directory.
Changes to the submitted files:
doc.docbook.mk The HTML generation depends on ${DSLHTML}, and the
print generation depends on ${DSLPRINT}. Changing
these files will force a rebuild (which makes testing
changes a little easier).
Removed ${DOC}.doc target. It's a hangover from when
I (mistakenly) thought that Jade could generate MS Word
.doc files.
Added support for using compress(1) to build .Z files
(been on my todo list for ages).
Fixed a couple of typos.
Submitted by: Neil Blakey-Milner <nbm@mithrandr.moria.org>
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
and encoding for the documentation that's currently being built (e.g.,
'en_US.ISO_8859-1', or 'es_ES.ISO_8859-1'). Used when building packages
to create part of the package file name. Setting this involves an
'interesting' kludge -- suggestions for how better to achieve this within
make(1) welcomed.
package-*:
No need to remove PLIST, it's always overwritten.
Create empty COMMENT and DESCR files if they don't exist. Makes it
easier to test this, without committing COMMENT and DESCR files all
over the tree.
Use the ${LANGCODE} variable in the package name. For example,
the HTML pkg for the FAQ now looks like faq.en_US.ISO_8859-1.html.tgz,
instead of just faq.html.tgz.
