Date: Fri, 2 May 2008 22:04:39 +0200 From: "Gabor PALI" <pgj@FreeBSD.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/123343: [patch] Fix $USER in Handbook Section 18.5 Message-ID: <481b73d8.1936440a.0d34.ffffcc70@mx.google.com> Resent-Message-ID: <200805022010.m42KA2D2005309@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 123343
>Category: docs
>Synopsis: [patch] Fix $USER in Handbook Section 18.5
>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: Fri May 02 20:10:02 UTC 2008
>Closed-Date:
>Last-Modified:
>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:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?481b73d8.1936440a.0d34.ffffcc70>