cvs commit: src/release/doc/en_US.ISO8859-1/early-adopter article.sgml src/release/doc/en_US.ISO8859-1/errata article.sgml src/release/doc/en_US.ISO8859-1/readme article.sgml

[Simon L. Nielsen]

On 2003.09.08 09:19:13 -0700, Bruce A. Mah wrote:
> The problem is that "Sparc64(R)" or "Sparc64" is not what we call the
> platform, it's "sparc64".  (Think of "/usr/src/sys/sparc64".)  In my
> mind, the use of "sparc64" above is just one step away from a
> filename, even though I never marked it up as such.  I think there was
> a use of "i386" that was similar.  It's not clear to me what's the
> right thing here.

Hmm, I see your point.  I think we need some way of differentiating
between Sparc64, the hardware architecture (just as an example, same
applies to i386/PowerPC/...), and the FreeBSD version running on Sparc64
(sometimes called FreeBSD/sparc64).  The most unambiguous way would be
to use FreeBSD/(sparc64|i386|powerpc|...) but that might be a bit to
"verbose"...

How about making entities for the FreeBSD architectures.  E.g.
&os.sparc64;, &os.i386; and so on.  It might be overkill, but it would
make it unambiguous what is meant in the DocBook source.  Might be
overkill though.

> A more clear-cut case:  What if I have some text that says "look in the
> <filename>sparc64</filename> directory".  Does this become the
> (completely incorrect) "look in the <filename>&sparc64;</filename>
> directory"?

No, in those cases I have just left the original text with no trademark
symbol (in general, not specificly in the release documentation).

> No criticism intended, this is good work.  I'm just trying to wrap my
> mind around it, as well as figure out all the implications of these
> changes.

Well, there are some cases where it's a bit unclear if the use of a word
that is a trademark should be marked up as such, so I would be a bit
surprised if there weren't some occurrences where I chose incorrectly.

-- 
Simon L. Nielsen
FreeBSD Documentation Team
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20030908/bfd2a0fa/attachment.sig>