From nobody@FreeBSD.org  Wed May 20 19:57:05 2009
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id E18251065676
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 20 May 2009 19:57:05 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id CF50E8FC15
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 20 May 2009 19:57:05 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id n4KJv57P078587
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 20 May 2009 19:57:05 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id n4KJv5k6078586;
	Wed, 20 May 2009 19:57:05 GMT
	(envelope-from nobody)
Message-Id: <200905201957.n4KJv5k6078586@www.freebsd.org>
Date: Wed, 20 May 2009 19:57:05 GMT
From: Benedict Reuschling <bcr@doc.bsdgroup.de>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [Handbook] Varying filename example is not included in <replaceable> element
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         134763
>Category:       docs
>Synopsis:       [handbook] [patch] Varying filename example is not included in <replaceable> element
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bcr
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed May 20 20:00:07 UTC 2009
>Closed-Date:    Wed Jun 17 18:17:26 UTC 2009
>Last-Modified:  Wed Jun 17 18:17:26 UTC 2009
>Originator:     Benedict Reuschling
>Release:        FreeBSD 7.2-STABLE
>Organization:
The FreeBSD German Documentation Project
>Environment:
FreeBSD atlantis.reuschling.org 7.2-STABLE FreeBSD 7.2-STABLE #19: Mon May  4 20:19:52 CEST 2009     root@atlantis.reuschling.org:/tank/obj/usr/src/sys/ATLANTIS  i386
>Description:
The multimedia-section in the FreeBSD handbook about MP3 Audio lists the following example:

<screen>&prompt.root; <userinput>mpg123 -a <replaceable>/dev/dsp1.0</replaceable> Foobar-GreatestHits.mp3</userinput> ...

Since "Foobar-GreatestHits.mp3" can be replaced by other filenames, it should be included in the preceding <replaceable> element.
>How-To-Repeat:
Look at the handbook section "7.3.1 MP3 Players" of doc/en_US.ISO8859-1/books/handbook/sound-mp3.html and guess what other .mp3 files you could use instead of Foobar-GreatestHits.mp3 :-) 
Therefore, it is a <replaceable> filename and should be typeset accordingly. 
>Fix:
Apply the attached patch that moves the "Foobar-GreatestHits.mp3" within the <replaceable> element.

Patch attached with submission follows:

--- chapter1.131.sgml	2009-05-20 21:37:07.628706721 +0200
+++ chapter.sgml	2009-05-20 21:40:03.750229988 +0200
@@ -483,7 +483,7 @@
 	the sound device and the MP3 file on the command line, as
 	shown below:</para>
 
-      <screen>&prompt.root; <userinput>mpg123 -a <replaceable>/dev/dsp1.0</replaceable> Foobar-GreatestHits.mp3</userinput>
+      <screen>&prompt.root; <userinput>mpg123 -a <replaceable>/dev/dsp1.0 Foobar-GreatestHits.mp3</replaceable></userinput>
 High Performance MPEG 1.0/2.0/2.5 Audio Player for Layer 1, 2 and 3.
 Version 0.59r (1999/Jun/15). Written and copyrights by Michael Hipp.
 Uses code from various people. See 'README' for more!


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->bcr 
Responsible-Changed-By: bcr 
Responsible-Changed-When: Fri Jun 5 20:12:56 UTC 2009 
Responsible-Changed-Why:  
I will take this one. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/134763: commit references a PR
Date: Wed, 17 Jun 2009 18:02:03 +0000 (UTC)

 bcr         2009-06-17 18:01:54 UTC
 
   FreeBSD doc repository
 
   Modified files:
     en_US.ISO8859-1/books/handbook/multimedia chapter.sgml 
   Log:
   Fix the section about MP3 audio:
   
   - use <devicename> for /dev/dsp1.0
   - wrap the FooBar-GreatestHits.mp3 example in <replaceable>
   - move the explanation before the sample screen output.
   
   PR:             docs/134763
   Approved by:    jkois (mentor)
   
   Revision  Changes    Path
   1.132     +5 -7      doc/en_US.ISO8859-1/books/handbook/multimedia/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: bcr 
State-Changed-When: Wed Jun 17 18:16:11 UTC 2009 
State-Changed-Why:  
Fixed by the commit above. Thanks! 

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