Skip site navigation (1)Skip section navigation (2)
Date:      Mon,  5 May 2008 20:05:34 +0200
From:      "Gabor PALI" <pgj@FreeBSD.org>
To:        FreeBSD-gnats-submit@FreeBSD.org
Subject:   docs/123423: [patch] Fix Misused <keycode> Tags in Handbook Chapter 24
Message-ID:  <481f4c71.1636440a.1bf6.2ea4@mx.google.com>
Resent-Message-ID: <200805051810.m45IA4Vi006044@freefall.freebsd.org>

next in thread | raw e-mail | index | archive | help

>Number:         123423
>Category:       docs
>Synopsis:       [patch] Fix Misused <keycode> 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:10:04 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:
	I found some misused <keycode> tags in the FreeBSD Handbook
	Chapter 24 (``Serial Communications''). I think they should be
	replaced with <keycap> tags, because they are instructing the
	user to press those keys. I did not find any <keycode> tags in
	the other chapters.

>How-To-Repeat:

>Fix:

--- serialcomms.patch.2.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 04:27:47 -0000
@@ -1317,7 +1317,7 @@
 	<prompt>login:</prompt> message at an initial speed and watches the
 	characters that come back in response.  If the user sees junk, it is
 	assumed that they know they should press the
-	<keycode>Enter</keycode> key until they see a recognizable
+	<keycap>Enter</keycap> key until they see a recognizable
 	prompt.  If the data rates do not match, <command>getty</command> sees
 	anything the user types as <quote>junk</quote>, tries going to the next
 	speed and gives the <prompt>login:</prompt> prompt again.  This
@@ -1744,7 +1744,7 @@
 	<para>Try dialing into the system; be sure to use 8 bits, no parity,
 	  and 1
 	  stop bit on the remote system.  If you do not get a prompt right
-	  away, or get garbage, try pressing <keycode>Enter</keycode>
+	  away, or get garbage, try pressing <keycap>Enter</keycap>
 	  about once per second.  If you still do not see a
 	  <prompt>login:</prompt> prompt after a while, try sending a
 	  <command>BREAK</command>. If you are using a high-speed modem to do
@@ -2455,7 +2455,7 @@
 	    you may want to do so in order to make sure things are set up
 	    correctly.</para>
 
-	  <para>Hit any key, other than <keycode>Enter</keycode>, at the console to
+	  <para>Hit any key, other than <keycap>Enter</keycap>, at the console to
 	    interrupt the boot process.  The boot blocks will then prompt you
 	    for further action.  You should now see something like:</para>
 
@@ -2466,12 +2466,12 @@
 	  <para>Verify the above message appears on either the serial or
 	    internal console or both, according to the options you put in
 	    <filename>/boot.config</filename>.  If the message appears in the
-	    correct console, hit <keycode>Enter</keycode> to continue the boot
+	    correct console, hit <keycap>Enter</keycap> to continue the boot
 	    process.</para>
 
 	  <para>If you want the serial console but you do not see the prompt
 	    on the serial terminal, something is wrong with your settings.  In
-	    the meantime, you enter <option>-h</option> and hit Enter/Return
+	    the meantime, you enter <option>-h</option> and hit <keycap>Enter</keycap> or <keycap>Return</keycap>
 	    (if possible) to tell the boot block (and then the boot loader and
 	    the kernel) to choose the serial port for the console. Once the
 	    system is up, go back and check what went wrong.</para>
--- serialcomms.patch.2.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?481f4c71.1636440a.1bf6.2ea4>