Bug 77535

Summary: [PATCH] s/CD-ROM/CDROM/g in ports chapter of the handbook
Product: Documentation Reporter: Jesus R.Camou <jcamou>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
handbook.ports.diff
none
writing-style.diff none

Description Jesus R.Camou 2005-02-14 23:50:16 UTC
	s/CD-ROM/CDROM/g in ports chapter of the handbook
Comment 1 David Adam 2005-02-15 01:12:43 UTC
Hi Jesus,

Seeing this patch triggered my memory - the issue has been brought up
before. I think we need to examine docs/38225
(http://www.freebsd.org/cgi/query-pr.cgi?pr=38225) first.

My personal preference is with O'Reilly Publishing's recommendation of
CD-ROM - http://www.oreilly.com/oreilly/author/stylesheet.html (see the
word list at the bottom of the page).

docs/38225 is almost three years old and hasn't been touched for over two
years. Perhaps the doc committers (ceri?) can let us know?

David Adam
zanchey@ucc.gu.uwa.edu.au
Comment 2 Marc Fonvieille freebsd_committer freebsd_triage 2005-02-15 07:24:32 UTC
On Tue, Feb 15, 2005 at 09:12:43AM +0800, David Adam wrote:
> Hi Jesus,
> 
> Seeing this patch triggered my memory - the issue has been brought up
> before. I think we need to examine docs/38225
> (http://www.freebsd.org/cgi/query-pr.cgi?pr=38225) first.
> 
> My personal preference is with O'Reilly Publishing's recommendation of
> CD-ROM - http://www.oreilly.com/oreilly/author/stylesheet.html (see the
> word list at the bottom of the page).
> 
> docs/38225 is almost three years old and hasn't been touched for over two
> years. Perhaps the doc committers (ceri?) can let us know?
>

Well, this is a "sensitive" problem that has been massively discussed on
-doc in past; for historic reason CDROM has been used in FreeBSD docs
(see Walnuts Creek CDs set...).
For consistency, it will be a huge work to change every
instance of the word in the doc/ tree, and I'm not sure it'll worth the
pain, the time, the bits used, etc.

Marc
Comment 3 Jesus R.Camou 2005-02-15 08:26:53 UTC
On Tue, Feb 15, 2005 at 01:20:20AM +0000, David Adam wrote:
> The following reply was made to PR docs/77535; it has been noted by GNATS.
> 
> From: David Adam <zanchey@ucc.gu.uwa.edu.au>
> To: "Jesus R. Camou" <jcamou@cox.net>
> Cc: FreeBSD-gnats-submit@FreeBSD.org, freebsd-doc@FreeBSD.org
> Subject: Re: docs/77535: [PATCH] s/CD-ROM/CDROM/g in ports chapter of the
>  handbook 
> Date: Tue, 15 Feb 2005 09:12:43 +0800 (WST)
> 
>  Hi Jesus,
>  
>  Seeing this patch triggered my memory - the issue has been brought up
>  before. I think we need to examine docs/38225
>  (http://www.freebsd.org/cgi/query-pr.cgi?pr=38225) first.
>  
>  My personal preference is with O'Reilly Publishing's recommendation of
>  CD-ROM - http://www.oreilly.com/oreilly/author/stylesheet.html (see the
>  word list at the bottom of the page).
>  
>  docs/38225 is almost three years old and hasn't been touched for over two
>  years. Perhaps the doc committers (ceri?) can let us know?

This change-request is due to the word list in the fdp primer book.
According to it, the FreeBSD Documentation Project should write  
CDROM instead of CD-ROM.  I remember your pr, as well as some others
trying to substitute CDROM with CD-ROM.  I have followed up prs to
use the same rule but at this point it is hard to change everything
to an specific way to spell it (even more if we are talking about
changing everything to CD-ROM), that is why I requested this change. 

It is hard to really tell how it should be written right now, I'm
just trying to follow the rule stated.  Thanks for the comment, I
think it would be a great idea to define how this should be done.
 
-- 
Jesus R. Camou <jcamou@COX.net>
jcamou@es.FreeBSD.org
Comment 4 Marc Fonvieille freebsd_committer freebsd_triage 2005-02-15 10:53:07 UTC
On Tue, Feb 15, 2005 at 08:24:32AM +0100, Marc Fonvieille wrote:
> 
> Well, this is a "sensitive" problem that has been massively discussed on
> -doc in past; for historic reason CDROM has been used in FreeBSD docs
> (see Walnuts Creek CDs set...).
> For consistency, it will be a huge work to change every
> instance of the word in the doc/ tree, and I'm not sure it'll worth the
> pain, the time, the bits used, etc.
>

I was not clear enough; CD-ROM seems to be the more widely used
spelling, most of new additions use CD-ROM, "legacy" docs use CDROM.
Since CD-ROM may be seen as the right solution, let's keep the old
spelling for the moment and just use CD-ROM in every new additions.

Marc
Comment 5 Simon L. B. Nielsen freebsd_committer freebsd_triage 2005-02-15 18:09:35 UTC
On 2005.02.15 11:53:07 +0100, Marc Fonvieille wrote:
> On Tue, Feb 15, 2005 at 08:24:32AM +0100, Marc Fonvieille wrote:
> > 
> > Well, this is a "sensitive" problem that has been massively discussed on
> > -doc in past; for historic reason CDROM has been used in FreeBSD docs
> > (see Walnuts Creek CDs set...).
> > For consistency, it will be a huge work to change every
> > instance of the word in the doc/ tree, and I'm not sure it'll worth the
> > pain, the time, the bits used, etc.
> 
> I was not clear enough; CD-ROM seems to be the more widely used
> spelling, most of new additions use CD-ROM, "legacy" docs use CDROM.
> Since CD-ROM may be seen as the right solution, let's keep the old
> spelling for the moment and just use CD-ROM in every new additions.


If that is the general sentiment (I don't really care), I think we
should update the FDP word list to reflect this.

BTW. semi-intresting google stats:

9,950,000 for CDROM
28,800,000 for "CD-ROM"

-- 
Simon L. Nielsen
Comment 6 Jesus R.Camou 2005-02-15 22:20:37 UTC
On Tue, Feb 15, 2005 at 07:09:35PM +0100, Simon L. Nielsen wrote:
> If that is the general sentiment (I don't really care), I think we
> should update the FDP word list to reflect this.
> 
> BTW. semi-intresting google stats:
> 
> 9,950,000 for CDROM
> 28,800,000 for "CD-ROM"
> 
> -- 
> Simon L. Nielsen

That is exactly what I thought while reading Marc's email.

Here's a patch.

-- 
Jesus R. Camou <jcamou@COX.net>
jcamou@es.FreeBSD.org

Comment 7 Simon L. B. Nielsen freebsd_committer freebsd_triage 2005-02-20 16:58:56 UTC
State Changed
From-To: open->closed

I committed the update to the FDP word list.  Thanks!