Date: Tue, 12 Jun 2001 09:13:39 -0700 From: "Bruce A. Mah" <bmah@FreeBSD.ORG> To: Kenneth W Cochran <kwc@world.std.com> Cc: freebsd-stable@FreeBSD.ORG Subject: Re: RELNOTESng problems Message-ID: <200106121613.f5CGDdl27734@bmah-freebsd-0.cisco.com> In-Reply-To: <200106121443.KAA18844@world.std.com> References: <200106121443.KAA18844@world.std.com>
next in thread | previous in thread | raw e-mail | index | archive | help
[-- Attachment #1 --]
If memory serves me right, Kenneth W Cochran wrote:
> With the recent move of RELNOTESng to -stable, what do we need
> to do to build/maintain this documentation along with source?
If you want to build a copy locally, install the textproc/docproj port
and bring in the doc-all collection from current. You got that right
as far as I can tell.
> For example, does {build,install}world take care of this?
> (Apparently not, but I'd appreciate The Official Word(tm). :)
Well, I'm the guy who designed RELNOTESng, so I guess I count as
"official" (?!?).
buildworld/installworld doesn't do this. I didn't even consider this,
because this would make buildworld and installworld take even longer
than they do now. :-)
> I tried going to /usr/src/release/doc & then "make" & I'm
> getting what appear to be build-errors. Attached are the last
> several output lines from that make. As per instructions in
> /usr/src/release/doc/README, I have built textproc/docproj
> from fresh -ports & additionally brought doc-all current.
We're kind of at a strange state right now; RELNOTESng for 4-STABLE is
broken (see my earlier heads-up) due to some other commits that took me
rather by surprise. I hope it'll get fixed soon (I know how to fix it,
but the fix depends on one or two decisions that are out of my hands.)
I think I know what problem you're seeing, and I can fix it after this
other (bigger) breakage gets fixed. I have no idea why earlier testing
didn't catch this problem. Sorry about that!
> So, to restate my question:
> 1. How do I build/maintain -stable documentation?
So far you seem to be doing the right thing.
> 2. How (where) do I go to look at said documentation?
When the build is done, you can point a Web browser at the subdirectorie
s under /usr/src/release/doc/en_US.ISO_8859-1/ and read the HTML files
there. If you did the build with additional document FORMATS (i.e "make
'FORMATS=html pdf txt'") you'll see the other output files there as
well.
Alternatively you can just read the Web versions at:
http://people.freebsd.org/~bmah/relnotes/
The plan is for these to be moved into a more "official" spot on the
FreeBSD web site and automatically generated along with the Web site
build.
> Commentary:
> While I think the move to RELNOTESng is probably a Good Thing,
> I think deletion/removal of the ascii-plaintext versions from
> src/release/texts/* is probably Not Such A Good Thing.
> Additionally, I "question" the necessity of requiring tools
> "outside" the base-OS solely for reading the relevant release
> notes/errata.
Noted. We debated this at some length on -doc when I was working on it.
The outcome of this debate was that we decided to put frequently-updated
versions of the release notes on the Web site (the URL I gave above is a
part of my testing process). I'd rather not rehash all the arguments
for this...you can see them in the -doc archives.
Bruce.
[-- Attachment #2 --]
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (FreeBSD)
Comment: Exmh version 2.3.1+ 05/14/2001
iD8DBQE7Jj+z2MoxcVugUsMRAqamAKCoQ5c7S84/4XOYoHbne2BOjSOe/wCgyLvf
LEduyo5sgwOIQU+oxFWZL5c=
=6TOb
-----END PGP SIGNATURE-----
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200106121613.f5CGDdl27734>