docs/123422: [patch] Fix <devicename> Tags in Handbook Chapter 24

[Gabor PALI]

>Number:         123422
>Category:       docs
>Synopsis:       [patch] Fix <devicename> Tags in Handbook Chapter 24
>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:   Mon May 05 18:00:05 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 at disznohal:/usr/obj/usr/src/sys/GENERIC_ i386

>Description:
	I found the COM ports referenced in the FreeBSD Handbook, Chapter 24
	(``Serial Communications'') are not always tagged by <devicename>.
	I created a patch to correct this.

>How-To-Repeat:

>Fix:

--- serialcomms.patch.1.diff begins here ---
Index: chapter.sgml
===================================================================
RCS file: /doc/en_US.ISO8859-1/books/handbook/serialcomms/chapter.sgml,v
retrieving revision 1.120
diff -u -r1.120 chapter.sgml
--- chapter.sgml	28 Dec 2007 11:11:43 -0000	1.120
+++ chapter.sgml	5 May 2008 03:45:34 -0000
@@ -864,7 +864,7 @@
 
 	<para>The <filename>/etc/ttys</filename> file lists all of the ports
 	  on your FreeBSD system where you want to allow logins.  For example,
-	  the first virtual console <filename>ttyv0</filename> has an entry in
+	  the first virtual console <devicename>ttyv0</devicename> has an entry in
 	  this file.  You can log in on the console using this entry.  This
 	  file also contains entries for the other virtual consoles, serial ports,
 	  and pseudo-ttys.  For a hardwired terminal, just list the serial
@@ -875,8 +875,8 @@
 
 	<para>A default FreeBSD install includes an
 	  <filename>/etc/ttys</filename> file with support for the first
-	  four serial ports: <filename>ttyd0</filename> through
-	  <filename>ttyd3</filename>.  If you are attaching a terminal
+	  four serial ports: <devicename>ttyd0</devicename> through
+	  <devicename>ttyd3</devicename>.  If you are attaching a terminal
 	  to one of those ports, you do not need to add another entry.</para>
 
 	<example id="ex-etc-ttys">
@@ -1054,7 +1054,7 @@
 	<para>You should see an entry for the terminal.  For
 	  example, the following display shows that a
 	  <command>getty</command> is running on the second serial
-	  port <literal>ttyd1</literal> and is using the
+	  port <devicename>ttyd1</devicename> and is using the
 	  <literal>std.38400</literal> entry in
 	  <filename>/etc/gettytab</filename>:</para>
 
@@ -1443,7 +1443,7 @@
 	<programlisting>ttyd0   "/usr/libexec/getty <replaceable>xxx</replaceable>"   dialup on</programlisting>
 
 	<para>The first item in the above line is the device special file for
-	  this entry — <literal>ttyd0</literal> means
+	  this entry — <devicename>ttyd0</devicename> means
 	  <filename>/dev/ttyd0</filename> is the file that this
 	  <command>getty</command> will be watching.  The second item,
 	  <literal>"/usr/libexec/getty
@@ -1726,7 +1726,7 @@
 
 	<para>If you do not see any <command>getty</command> processes waiting
 	  to open the desired
-	  <filename>ttyd<replaceable>N</replaceable></filename> port,
+	  <devicename>ttyd<replaceable>N</replaceable></devicename> port,
 	  double-check your entries in <filename>/etc/ttys</filename> to see
 	  if there are any mistakes there.  Also, check the log file
 	  <filename>/var/log/messages</filename> to see if there are any log
@@ -2151,7 +2151,7 @@
 	  <para>Edit <filename>/etc/ttys</filename> and change
 	    <literal>off</literal> to <literal>on</literal> and
 	    <literal>dialup</literal> to <literal>vt100</literal> for the
-	    <literal>ttyd0</literal> entry.  Otherwise a password will not be
+	    <devicename>ttyd0</devicename> entry.  Otherwise a password will not be
 	    required to connect via the serial console, resulting in a
 	    potential security hole.</para>
 	</step>
@@ -2771,7 +2771,7 @@
 ttyd2 "/usr/libexec/getty std.9600" unknown off secure
 ttyd3 "/usr/libexec/getty std.9600" unknown off secure</programlisting>
 
-	<para><literal>ttyd0</literal> through <literal>ttyd3</literal>
+	<para><devicename>ttyd0</devicename> through <devicename>ttyd3</devicename>
 	  corresponds to <devicename>COM1</devicename> through
 	  <devicename>COM4</devicename>.  Change <literal>off</literal> to
 	  <literal>on</literal> for the desired port.  If you have changed the
--- serialcomms.patch.1.diff ends here ---


>Release-Note:
>Audit-Trail:
>Unformatted: