From pali.gabor@googlemail.com  Fri May  2 20:04:49 2008
Return-Path: <pali.gabor@googlemail.com>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id DB17A1065679
	for <FreeBSD-gnats-submit@freebsd.org>; Fri,  2 May 2008 20:04:48 +0000 (UTC)
	(envelope-from pali.gabor@googlemail.com)
Received: from nf-out-0910.google.com (nf-out-0910.google.com [64.233.182.187])
	by mx1.freebsd.org (Postfix) with ESMTP id 1BA178FC16
	for <FreeBSD-gnats-submit@freebsd.org>; Fri,  2 May 2008 20:04:43 +0000 (UTC)
	(envelope-from pali.gabor@googlemail.com)
Received: by nf-out-0910.google.com with SMTP id h3so769703nfh.33
        for <FreeBSD-gnats-submit@freebsd.org>; Fri, 02 May 2008 13:04:41 -0700 (PDT)
Received: by 10.210.82.2 with SMTP id f2mr3377418ebb.159.1209758681925;
        Fri, 02 May 2008 13:04:41 -0700 (PDT)
Received: from pgj@FreeBSD.org ( [80.98.116.90])
        by mx.google.com with ESMTPS id c25sm5597531ika.11.2008.05.02.13.04.40
        (version=TLSv1/SSLv3 cipher=OTHER);
        Fri, 02 May 2008 13:04:40 -0700 (PDT)
Received: by pgj@FreeBSD.org (sSMTP sendmail emulation); Fri,  2 May 2008 22:04:39 +0200
Message-Id: <481b73d8.1936440a.0d34.ffffcc70@mx.google.com>
Date: Fri,  2 May 2008 22:04:39 +0200
From: "Gabor PALI" <pgj@FreeBSD.org>
Sender: =?UTF-8?B?UMOBTEkgR8OhYm9yIErDoW5vcw==?= <pali.gabor@googlemail.com>
Reply-To: Gabor PALI <pgj@FreeBSD.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [patch] Fix $USER in Handbook Section 18.5
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         123343
>Category:       docs
>Synopsis:       [patch] Fix $USER in Handbook Section 18.5
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    gabor
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri May 02 20:10:02 UTC 2008
>Closed-Date:    Wed May 07 15:11:47 UTC 2008
>Last-Modified:  Wed May 07 15:11:47 UTC 2008
>Originator:     Gabor PALI
>Release:        FreeBSD 6.3-STABLE i386
>Organization:
>Environment:
System: FreeBSD disznohal 6.3-STABLE FreeBSD 6.3-STABLE #4: Fri Apr 4 23:29:43 CEST 2008 dezzy@disznohal:/usr/obj/usr/src/sys/GENERIC_ i386

>Description:
	There is a double "markup" for the user's name in the
	FreeBSD Handbook, Section 18.5 (USB Storage Devices). The text
	mentions the environmental variable USER and uses its value
	by $USER. But I think it is ambiguous and it should not be marked
	replaceable, because it is not replaceable (by the user), it
	directly implements the right thing.
	
	I created alternative patches to give two different
	solutions to this problem.

	
>How-To-Repeat:

>Fix:

	Solution #1: Remove all $USER references and replace them
	with <replaceable> tags.

--- disks.patch.2.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/disks/chapter.sgml,v
retrieving revision 1.282
diff -u -r1.282 chapter.sgml
--- chapter.sgml	25 Mar 2008 08:43:38 -0000	1.282
+++ chapter.sgml	2 May 2008 19:40:59 -0000
@@ -858,19 +858,19 @@
 	the user that is to mount the file system.  One way to do that
 	is for <username>root</username> to create a subdirectory
 	owned by that user as
-	<filename>/mnt/<replaceable>$USER</replaceable></filename>
-	(replace <replaceable>$USER</replaceable> by the login name of
+	<filename>/mnt/<replaceable>username</replaceable></filename>
+	(replace <replaceable>username</replaceable> by the login name of
 	the actual user):</para>
 
-      <screen>&prompt.root; <userinput>mkdir /mnt/$USER</userinput>
-&prompt.root; <userinput>chown <replaceable>$USER</replaceable>:<replaceable>$USER</replaceable> /mnt/<replaceable>$USER</replaceable></userinput></screen>
+      <screen>&prompt.root; <userinput>mkdir /mnt/<replaceable>username</replaceable></userinput>
+&prompt.root; <userinput>chown <replaceable>user</replaceable>:<replaceable>user</replaceable> /mnt/<replaceable>user</replaceable></userinput></screen>
 
       <para>Suppose a USB thumbdrive is plugged in, and a device
 	<filename>/dev/da0s1</filename> appears.  Since these devices
 	usually come preformatted with a FAT file system, one can
 	mount them like this:</para>
 
-      <screen>&prompt.user; <userinput>mount -t msdosfs -m 644 -M 755 /dev/da0s1 /mnt/<replaceable>$USER</replaceable></userinput></screen>
+      <screen>&prompt.user; <userinput>mount -t msdosfs -m 644 -M 755 /dev/da0s1 /mnt/<replaceable>username</replaceable></userinput></screen>
 
       <para>If you unplug the device (the disk must be unmounted
 	before), you should see, in the system message buffer,
--- disks.patch.2.diff ends here ---


    Solution #2: Remove all <replaceable> tags.


--- disks.patch.3.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/disks/chapter.sgml,v
retrieving revision 1.282
diff -u -r1.282 chapter.sgml
--- chapter.sgml	25 Mar 2008 08:43:38 -0000	1.282
+++ chapter.sgml	2 May 2008 19:44:13 -0000
@@ -858,19 +858,19 @@
 	the user that is to mount the file system.  One way to do that
 	is for <username>root</username> to create a subdirectory
 	owned by that user as
-	<filename>/mnt/<replaceable>$USER</replaceable></filename>
-	(replace <replaceable>$USER</replaceable> by the login name of
+	<filename>/mnt/$USER</filename>
+	($USER will be replaced by the login name of
 	the actual user):</para>
 
       <screen>&prompt.root; <userinput>mkdir /mnt/$USER</userinput>
-&prompt.root; <userinput>chown <replaceable>$USER</replaceable>:<replaceable>$USER</replaceable> /mnt/<replaceable>$USER</replaceable></userinput></screen>
+&prompt.root; <userinput>chown $USER:$USER /mnt/$USER</userinput></screen>
 
       <para>Suppose a USB thumbdrive is plugged in, and a device
 	<filename>/dev/da0s1</filename> appears.  Since these devices
 	usually come preformatted with a FAT file system, one can
 	mount them like this:</para>
 
-      <screen>&prompt.user; <userinput>mount -t msdosfs -m 644 -M 755 /dev/da0s1 /mnt/<replaceable>$USER</replaceable></userinput></screen>
+      <screen>&prompt.user; <userinput>mount -t msdosfs -m 644 -M 755 /dev/da0s1 /mnt/$USER</userinput></screen>
 
       <para>If you unplug the device (the disk must be unmounted
 	before), you should see, in the system message buffer,
--- disks.patch.3.diff ends here ---


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->gabor 
Responsible-Changed-By: gabor 
Responsible-Changed-When: Fri May 2 20:30:05 UTC 2008 
Responsible-Changed-Why:  
Take. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=123343 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/123343: commit references a PR
Date: Wed,  7 May 2008 14:23:40 +0000 (UTC)

 gabor       2008-05-07 14:23:37 UTC
 
   FreeBSD doc repository
 
   Modified files:
     en_US.ISO8859-1/books/handbook/disks chapter.sgml 
   Log:
   - Use replaceable correctly.  Don't mark up the environment variable,
     use the "username" word instead.
   
   PR:             docs/123343
   Submitted by:   pgj
   
   Revision  Changes    Path
   1.285     +5 -5      doc/en_US.ISO8859-1/books/handbook/disks/chapter.sgml
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->closed 
State-Changed-By: gabor 
State-Changed-When: Wed May 7 15:11:26 UTC 2008 
State-Changed-Why:  
The first solution has been committed, thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=123343 
>Unformatted:
