Bug 38225

Summary: change "CDROM" to "CD-ROM"
Product: Documentation Reporter: Trevor Johnson <trevor>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Trevor Johnson 2002-05-18 08:20:01 UTC
It appears that "CDROM" is a misspelling of "CD-ROM."  These URLs
support this idea (Philips and Sony invented the medium, so I feel
they are authoritative for its name):

 http://sdm.sony.com/art/cdlogos.html
 http://sdm.sony.com/techinfo/bythebook.html
 http://www.licensing.philips.com/information/cd/video/
 http://www.search.philips.com/?a=0&text=cd-rom
 http://www.search.philips.com/?a=0&text=cdrom
 ftp://ftp.ecma.ch/ecma-st/Ecma-130.pdf
 http://foldoc.doc.ic.ac.uk/foldoc/foldoc.cgi?query=cdrom
 http://www.pctechguide.com/08cd-rom.htm
 http://www.webopedia.com/TERM/C/CD_ROM.html

Therefore, I have prepared a patch to change "CDROM" to "CD-ROM"
in doc/ and www/ with a few exceptions:

- Walnut Creek CDROM
- CDROM Support BBS
- CDROM environment variable
- NO_CDROM

The patch changes 1346 lines in 286 files.

Fix: 

http://people.freebsd.org/~trevor/doc/cd-rom.diff.bz2
How-To-Repeat: 
N/A
Comment 1 Trevor Johnson freebsd_committer freebsd_triage 2002-05-18 08:23:15 UTC
Responsible Changed
From-To: doc->freebsd-doc

misfiled PR
Comment 2 Marc Fonvieille freebsd_committer freebsd_triage 2002-07-15 11:27:34 UTC
Hello,

About that question of "CDROM" or "CD-ROM", at first i had the same
reaction as yours. However "CDROM" is the choice of the docproj, have a
look to:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/x3258.html

which the word list to use, and to that commit log about this problem:

http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/handbook/install/chapter.sgml?rev=1.72&content-type=text/x-cvsweb-markup

Marc
Comment 4 Trevor Johnson 2002-07-17 00:42:20 UTC
On Tue, 16 Jul 2002, Marc Fonvieille wrote:

> Synopsis: change "CDROM" to "CD-ROM"
>
> State-Changed-From-To: open->closed
> State-Changed-By: blackend
> State-Changed-When: Tue Jul 16 16:22:21 PDT 2002
> State-Changed-Why:
> "CDROM" is the choice of the docproj, have a look to:
> http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/x3258.html
> and
> http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/handbook/install/chapter.sgml?rev=1.72&content-type=text/x-cvsweb-markup

The PR contains abundant evidence that this choice was incorrect, and the
accompanying patch changes the word list in the style guide.

> http://www.freebsd.org/cgi/query-pr.cgi?pr=38225
-- 
Trevor Johnson
Comment 5 Trevor Johnson freebsd_committer freebsd_triage 2002-07-17 00:43:06 UTC
State Changed
From-To: closed->open

With the patch accompanying this PR, I proposed to change 
doc/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml . 
The fact that the patch has not yet been applied is IMO not a valid 
reason for closing the PR.
Comment 6 Trevor Johnson 2002-07-17 01:14:22 UTC
> State-Changed-From-To: closed->open
> State-Changed-By: trevor
> State-Changed-When: Tue Jul 16 16:43:06 PDT 2002
> State-Changed-Why:
> With the patch accompanying this PR, I proposed to change
> doc/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml .
> The fact that the patch has not yet been applied is IMO not a valid
> reason for closing the PR.
>
> http://www.freebsd.org/cgi/query-pr.cgi?pr=38225

Before I submitted this PR, I was advised in a private e-mail that I
should "launch a campaign to change the word-list of the FDP."  If this PR
is not the proper way to do so, please let me know what the procedure is.
My correspondent told me that the existence of Walnut Creek CDROM was a
factor in the choice of "CDROM" over "CD-ROM."  A (probably related)
factor was that "CDROM" already outnumbered "CD-ROM," so it was easier to
change to the incorrect spelling.  With the company's unfortunate demise,
the decision should be reconsidered.

Oftentimes, words are intentionally misspelled (for example "EZ,"
"Cheez," or "Wip") in order to make a trademark more enforceable.
Perhaps that happened here.
-- 
Trevor Johnson
Comment 7 Marc Fonvieille freebsd_committer freebsd_triage 2002-07-23 11:16:48 UTC
Responsible Changed
From-To: freebsd-doc->ceri

Ceri will work on it.
Comment 8 Trevor Johnson 2002-08-07 14:34:31 UTC
Nik Clayton wrote:

> FWIW,
>
> On Mon, Jul 29, 2002 at 08:39:37AM -0400, John Baldwin wrote:
> > Given that the paper that _defines_ what a CD-ROM looks like uses CD-ROM,
> > I think that is pretty definitive. :)
>
> If pushed, I'm inclined to agree.  However, it's also not anything I'm
> going to lose sleep over.  If someone's willing to put the effort in to
> go over the {src,doc} trees and do an intelligent s/CDROM/CD-ROM/ then
> I'm not going to stop them.  But I do think we have other things that
> the time could be spent on.

I've prepared a patch against the -CURRENT src/, to accompany the earlier
one for doc/ and www/.  It would change not just documentation but some
textual output (if that is considered beyond the scope of such a patch, I
don't mind scaling it back).  I left intact some instances of "CDROM" in
the Japanese documentation because I was not sure whether they referred to
some of the exceptions.  I also left intact the names of all variables,
macros, and so forth.

According to diffstat, this second patch would make 263 changes in 74
files (including share/freebsd/dict as requested, loosely speaking, by
blackend).  It is at
<URL:http://people.FreeBSD.org/~trevor/doc/38225-src.diff.bz2>.
-- 
Trevor Johnson
Comment 9 Ceri Davies freebsd_committer freebsd_triage 2003-01-23 23:42:18 UTC
Responsible Changed
From-To: ceri->freebsd-doc

Throw this back to the doc team.
Comment 10 Simon L. B. Nielsen freebsd_committer freebsd_triage 2005-02-20 17:02:07 UTC
State Changed
From-To: open->closed

Close PR since I just changed the FDP word list to say CD-ROM, but the 
general stance seems to be that there is no reason to do a sweep to 
update existing documentation to CD-ROM (note, personally I don't care 
either way), which is also shown by the fact that nobody has committed 
this PR in 3 years.