From pali.gabor@googlemail.com  Mon May  5 18:18:21 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 0370D1065671
	for <FreeBSD-gnats-submit@freebsd.org>; Mon,  5 May 2008 18:18:21 +0000 (UTC)
	(envelope-from pali.gabor@googlemail.com)
Received: from fg-out-1718.google.com (fg-out-1718.google.com [72.14.220.159])
	by mx1.freebsd.org (Postfix) with ESMTP id 84D438FC0C
	for <FreeBSD-gnats-submit@freebsd.org>; Mon,  5 May 2008 18:18:20 +0000 (UTC)
	(envelope-from pali.gabor@googlemail.com)
Received: by fg-out-1718.google.com with SMTP id l26so1911898fgb.35
        for <FreeBSD-gnats-submit@freebsd.org>; Mon, 05 May 2008 11:18:19 -0700 (PDT)
Received: by 10.86.90.13 with SMTP id n13mr149355fgb.64.1210011499240;
        Mon, 05 May 2008 11:18:19 -0700 (PDT)
Received: from pgj@FreeBSD.org ( [80.98.116.90])
        by mx.google.com with ESMTPS id c28sm11921690fka.4.2008.05.05.11.18.17
        (version=TLSv1/SSLv3 cipher=OTHER);
        Mon, 05 May 2008 11:18:18 -0700 (PDT)
Received: by pgj@FreeBSD.org (sSMTP sendmail emulation); Mon,  5 May 2008 20:18:16 +0200
Message-Id: <481f4f6a.1c365e0a.1720.ffffab0e@mx.google.com>
Date: Mon,  5 May 2008 20:18:16 +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 Wrong <keycap> Tag in Handbook Section 24.5.2
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         123425
>Category:       docs
>Synopsis:       [patch] Fix Wrong <keycap> Tag in Handbook Section 24.5.2
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    gabor
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon May 05 18:20:03 UTC 2008
>Closed-Date:    Tue May 06 15:58:14 UTC 2008
>Last-Modified:  Tue May 06 15:58:14 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:
	I found a misused <keycap> tag in the FreeBSD Handbook, Chapter
	24 (``Serial Communications''), Section 24.5.2 (``How Am I Expected
	to Enter These AT Commands?''). I never used tip(1) but the man
	page of it tells me those escape signals (prefixed by a tilde
	character) are not simply keys but keystrokes or commands.
	Therefore I think it should be marked up as a <command> (as in
	the other parts of the chapter).


>How-To-Repeat:

>Fix:

--- serialcomms.patch.3.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:37:34 -0000
@@ -1865,7 +1865,7 @@
 	(e.g.<filename>/dev/cuad0</filename>) and
 	<replaceable>speed</replaceable> is the speed
 	(e.g.<literal>57600</literal>).  When you are done entering the AT
-	commands hit <keycap>~.</keycap> to exit.</para>
+	commands type <command>~.</command> to exit.</para>
     </sect2>
 
     <sect2>
--- serialcomms.patch.3.diff ends here ---


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->gabor 
Responsible-Changed-By: gabor 
Responsible-Changed-When: Mon May 5 22:47:14 UTC 2008 
Responsible-Changed-Why:  
Take. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/123425: commit references a PR
Date: Tue,  6 May 2008 12:58:16 +0000 (UTC)

 gabor       2008-05-06 12:58:09 UTC
 
   FreeBSD doc repository
 
   Modified files:
     en_US.ISO8859-1/books/handbook/serialcomms chapter.sgml 
   Log:
   - Mark up a tip.1 command with the command element instead of keycap [1]
   - Mark up hosts with hostid element [2]
   - Use replaceable element instead of putting the value between &lt;
     and &gt; [3]
   
   PR:             docs/123425 [1], docs/123426 [2], docs/123427 [3]
   Submitted by:   pgj
   
   Revision  Changes    Path
   1.123     +4 -4      doc/en_US.ISO8859-1/books/handbook/serialcomms/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: Tue May 6 15:57:09 UTC 2008 
State-Changed-Why:  
Committed, thanks! 

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