Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 24 Apr 2000 11:11:05 +0100
From:      Nik Clayton <nik@freebsd.org>
To:        Sheldon Hearn <sheldonh@uunet.co.za>
Cc:        doc@FreeBSD.org
Subject:   Re: Plan to incorporate chapter 2 of the 4.4BSD book
Message-ID:  <20000424111105.B12023@kilt.nothing-going-on.org>
In-Reply-To: <93043.955379404@axl.ops.uunet.co.za>; from sheldonh@uunet.co.za on Mon, Apr 10, 2000 at 05:10:04PM %2B0200
References:  <93043.955379404@axl.ops.uunet.co.za>

next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, Apr 10, 2000 at 05:10:04PM +0200, Sheldon Hearn wrote:
> A draft copy of the chapter of the 4.4BSD book which we've been given
> permission to reproduce is available for examination at:
> 
> 	http://www.freebsd.org/~sheldonh/design44bsd/

Oh bugger.  Threaded mail readers are great, but people will insist on 
posting replies to threads that have long since scrolled off the top of
my window.

I've only just seen this.  Can you give me a day or two to take a look at
it.

> I'll ask Addision-Wesley how they feel about this stuff getting onto our
> CDROMs.

Cheers.

> In the mean time, I'd appreciate feedback from anyone who knows about
> bits which have changed in FreeBSD which need to be marked as such in
> chapter.  The idea is that the text describing each changed aspect
> should be flagged with a "Changed in FreeBSD" hypertext link into a list
> of changes.

    <note>
      <para>This has since been changed in FreeBSD.  See <xref
         linkend="aw-changes-foo"> for more details.</para>
    </note>

Possibly without the surrounding <note>.  Then have a 

    <sectn id="aw-changes">
      <title>Changes in FreeBSD.</para>

      <formalpara id="aw-changes-foo">
        <title>Changes to the Foo Frobnicator</title>

        <para>FreeBSD now has a unified Foo Frobnication mechanism, which
          is more efficient than the split scheme described. . .</para>
      </formalpara>
  
      ...
    </sectn>

(where the 'n' in '<sectn>' is replaced with an appropriate number).  That'd
be my first choice.  Possibly wrapping an <itemizedlist> around all the 
<formalpara>s as well.

In this instance they need to be <formalpara>, because they need a title.
Without a title, <xref ...> can't generate the text of the link correctly.
The alternative would be to use 

    ... see <link linkend="aw-changes-foo">changes to the Foo 
       Frobnicator<link> for more details.</para>

    [...]

    <para id="aw-changes-foo">FreeBSD now has a unified ... </para>

which I don't like as much.  I think each change should get its own
title -- <formalpara> lets you do that without giving each change its
own <sectn>, which would be overkill IMHO.

More info when I've seen the chapter.

N
-- 
Internet connection, $19.95 a month.  Computer, $799.95.  Modem, $149.95.
Telephone line, $24.95 a month.  Software, free.  USENET transmission,
hundreds if not thousands of dollars.  Thinking before posting, priceless.
Somethings in life you can't buy.  For everything else, there's MasterCard.
  -- Graham Reed, in the Scary Devil Monastery


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20000424111105.B12023>