Bug 92973

Summary: [patch] mailto.sgml
Product: Documentation Reporter: Gabor Kovesdan <gabor.kovesdan>
Component: Books & ArticlesAssignee: Gabor Kovesdan <gabor>
Status: Closed FIXED    
Severity: Affects Only Me CC: gabor.kovesdan
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
mailto.sgml.diff none

Description Gabor Kovesdan 2006-02-07 15:20:04 UTC
s/CDROM/CD-ROM/ for consistency. It's used in this way on the website.
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2006-02-10 14:38:58 UTC
State Changed
From-To: open->closed

Actually, it isn't.  The occurences of 'CDROM' are far more 
in number than those of 'CD-ROM', so I don't think it's worth 
changing just this one: 

$ cd /w/bsd/www/en 
$ find . -type f | fgrep -v /CVS/ | xargs fgrep 'CDROM' | wc -l 
2410 
$ find . -type f | fgrep -v /CVS/ | xargs fgrep 'CD-ROM' | wc -l 
517 

Thanks for the helpful PR, but unless there is a very good 
reason to start making sweeps for s/CDROM/CD-ROM/ in the site 
it's probably just not worth it to change these one by one.
Comment 2 Giorgos Keramidas freebsd_committer freebsd_triage 2006-02-10 15:36:15 UTC
State Changed
From-To: closed->open

Pav has suggested that this is a valid change. 
Reopen the PR, so we can use it to track down this 
and other similar changes to www/ for s/CDROM/CD-ROM/.
Comment 3 Ceri Davies 2006-02-10 16:21:02 UTC
On 10 Feb 2006, at 15:18, Pav Lucistnik wrote:

> Giorgos Keramidas píe v pá 10. 02. 2006 v 14:41 +0000:
>> Synopsis: [patch] mailto.sgml
>>
>> State-Changed-From-To: open->closed
>> State-Changed-By: keramida
>> State-Changed-When: Fri Feb 10 14:38:58 UTC 2006
>> State-Changed-Why:
>> Actually, it isn't.  The occurences of 'CDROM' are far more
>> in number than those of 'CD-ROM', so I don't think it's worth
>> changing just this one:
>>
>> $ cd /w/bsd/www/en
>> $ find . -type f | fgrep -v /CVS/ | xargs fgrep 'CDROM' | wc -l
>>     2410
>> $ find . -type f | fgrep -v /CVS/ | xargs fgrep 'CD-ROM' | wc -l
>>      517
>>
>> Thanks for the helpful PR, but unless there is a very good
>> reason to start making sweeps for s/CDROM/CD-ROM/ in the site
>> it's probably just not worth it to change these one by one.
>
> I think you should be changing them, and it does not matter if one  
> at a
> time or sweeping.
>
> CD-ROM spelling is required by Documentation Primer.


You know it would be a lot less work to remove that line from the  
Primer :)

Seriously though, there is no need for a PR; this should just be
something cultural along the lines of <filename> -> <filename  
role="directory">.

ceri

Comment 4 Remko Lodder freebsd_committer freebsd_triage 2006-03-12 14:00:01 UTC
State Changed
From-To: open->suspended

This should be ongoing work as ceri pointed out, like 
converting <filename> tags to their appropriate role 
etc.  We can do that when we work in the section of 
the documentation anyway. 

I will suspend this PR for that reason.
Comment 5 Gabor Kovesdan freebsd_committer freebsd_triage 2007-04-14 13:21:07 UTC
State Changed
From-To: suspended->open

Well, I think it is still relevant. I we don't respect our consistency and 
style rules, the translations that grow from the original documents won't do 
that either. I'll sweep the webpages and make this consistent. 


Comment 6 Gabor Kovesdan freebsd_committer freebsd_triage 2007-04-14 13:21:07 UTC
Responsible Changed
From-To: freebsd-www->gabor

Well, I think it is still relevant. I we don't respect our consistency and 
style rules, the translations that grow from the original documents won't do 
that either. I'll sweep the webpages and make this consistent.
Comment 7 Marc Fonvieille freebsd_committer freebsd_triage 2007-04-14 14:11:54 UTC
On Sat, Apr 14, 2007 at 12:22:54PM +0000, Gabor Kovesdan wrote:
> Synopsis: [patch] mailto.sgml
> 
> State-Changed-From-To: suspended->open
> State-Changed-By: gabor
> State-Changed-When: Sat Apr 14 12:21:07 UTC 2007
> State-Changed-Why: 
> Well, I think it is still relevant. I we don't respect our consistency and
> style rules, the translations that grow from the original documents won't do
> that either. I'll sweep the webpages and make this consistent.
> 
> 
> Responsible-Changed-From-To: freebsd-www->gabor
> Responsible-Changed-By: gabor
> Responsible-Changed-When: Sat Apr 14 12:21:07 UTC 2007
> Responsible-Changed-Why: 
> Well, I think it is still relevant. I we don't respect our consistency and
> style rules, the translations that grow from the original documents won't do
> that either. I'll sweep the webpages and make this consistent.
>

I think it should stay suspended or simply closed as it was the case for
previous PRs regarding this particular spelling.
The spelling CDROM has a particular meaning/reason relative to FreeBSD:
ftp.cdrom.com and Walnut Creeks CDROM.  It's part of FreeBSD (and
docproj) history.  And the beginning of the PR proposing s/CDROMs/CD-ROMs/
for the CDROMs box set from FreeBSDmall is a blasphemy :-))

-- 
Marc
Comment 8 Gabor Kovesdan freebsd_committer freebsd_triage 2007-04-14 14:29:29 UTC
Marc Fonvieille schrieb:
> On Sat, Apr 14, 2007 at 12:22:54PM +0000, Gabor Kovesdan wrote:
>   
>> Synopsis: [patch] mailto.sgml
>>
>> State-Changed-From-To: suspended->open
>> State-Changed-By: gabor
>> State-Changed-When: Sat Apr 14 12:21:07 UTC 2007
>> State-Changed-Why: 
>> Well, I think it is still relevant. I we don't respect our consistency and
>> style rules, the translations that grow from the original documents won't do
>> that either. I'll sweep the webpages and make this consistent.
>>
>>
>> Responsible-Changed-From-To: freebsd-www->gabor
>> Responsible-Changed-By: gabor
>> Responsible-Changed-When: Sat Apr 14 12:21:07 UTC 2007
>> Responsible-Changed-Why: 
>> Well, I think it is still relevant. I we don't respect our consistency and
>> style rules, the translations that grow from the original documents won't do
>> that either. I'll sweep the webpages and make this consistent.
>>
>>     
>
> I think it should stay suspended or simply closed as it was the case for
> previous PRs regarding this particular spelling.
> The spelling CDROM has a particular meaning/reason relative to FreeBSD:
> ftp.cdrom.com and Walnut Creeks CDROM.  It's part of FreeBSD (and
> docproj) history.  And the beginning of the PR proposing s/CDROMs/CD-ROMs/
> for the CDROMs box set from FreeBSDmall is a blasphemy :-))
>
>   
Ok, than what about fixing the fdp-primer? It explicitly says CD-ROM 
should be used:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-word-list.html

Gabor
Comment 9 Gabor Kovesdan freebsd_committer freebsd_triage 2007-04-14 14:33:09 UTC
Marc Fonvieille schrieb:
> On Sat, Apr 14, 2007 at 12:22:54PM +0000, Gabor Kovesdan wrote:
>   
>> Synopsis: [patch] mailto.sgml
>>
>> State-Changed-From-To: suspended->open
>> State-Changed-By: gabor
>> State-Changed-When: Sat Apr 14 12:21:07 UTC 2007
>> State-Changed-Why: 
>> Well, I think it is still relevant. I we don't respect our consistency and
>> style rules, the translations that grow from the original documents won't do
>> that either. I'll sweep the webpages and make this consistent.
>>
>>
>> Responsible-Changed-From-To: freebsd-www->gabor
>> Responsible-Changed-By: gabor
>> Responsible-Changed-When: Sat Apr 14 12:21:07 UTC 2007
>> Responsible-Changed-Why: 
>> Well, I think it is still relevant. I we don't respect our consistency and
>> style rules, the translations that grow from the original documents won't do
>> that either. I'll sweep the webpages and make this consistent.
>>
>>     
>
> I think it should stay suspended or simply closed as it was the case for
> previous PRs regarding this particular spelling.
> The spelling CDROM has a particular meaning/reason relative to FreeBSD:
> ftp.cdrom.com and Walnut Creeks CDROM.  It's part of FreeBSD (and
> docproj) history.  And the beginning of the PR proposing s/CDROMs/CD-ROMs/
> for the CDROMs box set from FreeBSDmall is a blasphemy :-))
>
>   
Ok, than what about fixing the fdp-primer? It explicitly says CD-ROM 
should be used:

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-word-list.html

Gabor
Comment 10 Marc Fonvieille freebsd_committer freebsd_triage 2007-04-14 14:59:07 UTC
On Sat, Apr 14, 2007 at 03:29:29PM +0200, Gabor Kovesdan wrote:
> Marc Fonvieille schrieb:
> >On Sat, Apr 14, 2007 at 12:22:54PM +0000, Gabor Kovesdan wrote:
> >  
> >>Synopsis: [patch] mailto.sgml
> >>
> >>State-Changed-From-To: suspended->open
> >>State-Changed-By: gabor
> >>State-Changed-When: Sat Apr 14 12:21:07 UTC 2007
> >>State-Changed-Why: 
> >>Well, I think it is still relevant. I we don't respect our consistency and
> >>style rules, the translations that grow from the original documents won't 
> >>do
> >>that either. I'll sweep the webpages and make this consistent.
> >>
> >>
> >>Responsible-Changed-From-To: freebsd-www->gabor
> >>Responsible-Changed-By: gabor
> >>Responsible-Changed-When: Sat Apr 14 12:21:07 UTC 2007
> >>Responsible-Changed-Why: 
> >>Well, I think it is still relevant. I we don't respect our consistency and
> >>style rules, the translations that grow from the original documents won't 
> >>do
> >>that either. I'll sweep the webpages and make this consistent.
> >>
> >>    
> >
> >I think it should stay suspended or simply closed as it was the case for
> >previous PRs regarding this particular spelling.
> >The spelling CDROM has a particular meaning/reason relative to FreeBSD:
> >ftp.cdrom.com and Walnut Creeks CDROM.  It's part of FreeBSD (and
> >docproj) history.  And the beginning of the PR proposing s/CDROMs/CD-ROMs/
> >for the CDROMs box set from FreeBSDmall is a blasphemy :-))
> >
> >  
> Ok, than what about fixing the fdp-primer? It explicitly says CD-ROM 
> should be used:
> 
> http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/writing-style-word-list.html
>

Commit log from the Revision 1.43 (the one responsible of the addition
of this spelling):

---
Change CDROM to CD-ROM in the word list, since the later seems to be
most widely used.  This is not really a change of policy, just
documenting the current de facto policy.

Quoting blackend (but don't blame this commit on him):

	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.

Semi-intresting google statistics: 9,950,000 hits for CDROM,
28,800,000 hits for "CD-ROM".
---

This confirm what other persons suggested to you in the PR follow-ups.

-- 
Marc
Comment 11 Gabor Kovesdan freebsd_committer freebsd_triage 2007-04-14 15:05:39 UTC
State Changed
From-To: open->closed

OK, closing this after the discussion with blackend@.