Bug 149447

Summary: [patch][handbook] Chapter 3 UNIX Basics: Replace instances of "FreeBSD" with "&os;"
Product: Documentation Reporter: Glen Barber <glen.j.barber>
Component: Books & ArticlesAssignee: Johann Kois <jkois>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Glen Barber 2010-08-08 23:00:23 UTC 
In feedback received for a previously submitted patch, it was mentioned I should use "&os;" in place of "FreeBSD" in SGML documents.  I found many instances of "FreeBSD" where "&os;" should probably be used.  The attached patch, generated against revision 1.157 of doc/en_US.ISO8859-1/books/handbook/basics/chapter.sgml, makes this change where applicable.

Fix: Patch attached with submission follows:
Comment 1 Johann Kois freebsd_committer freebsd_triage 2010-08-09 11:51:44 UTC 
Responsible Changed
From-To: freebsd-doc->jkois

take.
Comment 2 Marc Fonvieille freebsd_committer freebsd_triage 2010-08-10 08:13:01 UTC 
On Sun, Aug 08, 2010 at 09:58:41PM +0000, Glen Barber wrote:
> 
> >Number:         149447
> >Category:       docs
> >Synopsis:       [patch][handbook] Chapter 3 UNIX Basics: Replace instances of "FreeBSD" with "&os;"
> >Confidential:   no
> >Severity:       non-critical
> >Priority:       low
> >Responsible:    freebsd-doc
> >State:          open
> >Quarter:        
> >Keywords:       
> >Date-Required:
> >Class:          doc-bug
> >Submitter-Id:   current-users
> >Arrival-Date:   Sun Aug 08 22:00:23 UTC 2010
> >Closed-Date:
> >Last-Modified:
> >Originator:     Glen Barber
> >Release:        8.1-PRERELEASE
> >Organization:
> >Environment:
> FreeBSD orion 8.1-PRERELEASE FreeBSD 8.1-PRERELEASE #3 r210428: Sat Jul 24 13:37:37 EDT 2010     root@orion:/usr/obj/usr/src/sys/ORION  amd64
> >Description:
> In feedback received for a previously submitted patch, it was
> mentioned I should use "&os;" in place of "FreeBSD" in SGML documents.

True but in new additions.  It was discussed in past (long time ago)
that we have to use &os; when we add/write a new thing but we should not
do a full s/FreeBSD/&os; cause it brings nothing to the reader and will just
add thousand lines changes to the repo.  Please don't do that.

-- 
Marc
Comment 3 Johann Kois freebsd_committer freebsd_triage 2010-08-10 21:17:25 UTC 
State Changed
From-To: open->closed

Close this PR. 

There is an agreement within the FDP to keep old instances of "FreeBSD" as "FreeBSD".  Only for new stuff we use "&os;" instead of "FreeBSD".