From mwlucas@blackhelicopters.org  Mon Nov 12 11:18:32 2001
Return-Path: <mwlucas@blackhelicopters.org>
Received: from blackhelicopters.org (geburah.blackhelicopters.org [209.69.178.18])
	by hub.freebsd.org (Postfix) with ESMTP id 0EBF837B417
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 12 Nov 2001 11:18:32 -0800 (PST)
Received: (from mwlucas@localhost)
	by blackhelicopters.org (8.9.3/8.9.3) id OAA29898;
	Mon, 12 Nov 2001 14:18:31 -0500 (EST)
	(envelope-from mwlucas)
Message-Id: <200111121918.OAA29898@blackhelicopters.org>
Date: Mon, 12 Nov 2001 14:18:31 -0500 (EST)
From: mwlucas@blackhelicopters.org
Reply-To: mwlucas@blackhelicopters.org
To: FreeBSD-gnats-submit@freebsd.org
Subject: port tag not in FDP
X-Send-Pr-Version: 3.2

>Number:         31934
>Category:       docs
>Synopsis:       port tag not in FDP
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Mon Nov 12 11:20:00 PST 2001
>Closed-Date:    Tue Nov 13 10:07:55 PST 2001
>Last-Modified:  Tue Nov 13 10:09:07 PST 2001
>Originator:     Michael Lucas
>Release:        FreeBSD 3.5-STABLE i386
>Organization:
None
>Environment:

today's -doc tree

>Description:

The <port> tag was not documented in the FDP.  This made some of my
earlier patches less than perfect.

>How-To-Repeat:


>Fix:

*** en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml-dist	Mon Nov 12 11:21:53 2001
--- en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml	Mon Nov 12 14:12:43 2001
***************
*** 2165,2170 ****
--- 2165,2193 ----
  	    value for <replaceable>n</replaceable>.</para>	  
  	</example>
        </sect3>
+ 
+       <sect3>
+         <title>The name of ports</title>
+ 	
+         <para>You might need to include the name of a program from the
+           FreeBSD Ports Collection in the documentation.  Use the
+           <sgmltag>port</sgmltag> tag to identify these.  Since ports
+           can be installed in any number of locations, only include
+           the category and the port name; do not include
+           <filename>/usr/ports</filename>.</para>
+ 
+         <example>
+           <title><sgmltag>portname</sgmltag></title>
+ 
+           <para>Use:</para>
+ 
+           <programlisting><![ CDATA [<para>Install <port>net/ethereal</literal> to view network traffic.</para>]]></programlisting>
+ 
+           <para>Appearance:</para>
+ 	  
+           <para>Install <port>net/ethereal</port> to view network traffic.</para>
+         </example>
+       </sect3>
      </sect2>
  
      <sect2>
>Release-Note:
>Audit-Trail:

From: Giorgos Keramidas <charon@labs.gr>
To: mwlucas@blackhelicopters.org
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/31934: port tag not in FDP
Date: Tue, 13 Nov 2001 00:12:51 +0200

 mwlucas@blackhelicopters.org <mwlucas@blackhelicopters.org> wrote:
 > +           <para>Use:</para>
 > + 
 > +           <programlisting><![ CDATA [<para>Install <port>net/ethereal</literal> to view network traffic.</para>]]></programlisting>
 
 	I'm sure you meant "Install <port>net/ethereal</port>..."
 	I like this :-)
 

From: Michael Lucas <mwlucas@blackhelicopters.org>
To: Giorgos Keramidas <charon@labs.gr>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/31934: port tag not in FDP
Date: Tue, 13 Nov 2001 07:48:30 -0500

 --/9DWx/yDrRhgMJTb
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: inline
 
 On Tue, Nov 13, 2001 at 12:12:51AM +0200, Giorgos Keramidas wrote:
 > mwlucas@blackhelicopters.org <mwlucas@blackhelicopters.org> wrote:
 > > +           <para>Use:</para>
 > > + 
 > > +           <programlisting><![ CDATA [<para>Install <port>net/ethereal</literal> to view network traffic.</para>]]></programlisting>
 > 
 > 	I'm sure you meant "Install <port>net/ethereal</port>..."
 > 	I like this :-)
 
 Yes I did.  How the heck does this pass "make lint"?  make lint
 complains about just about everything (which it should), yet this
 obvious boneheaded cut-and-paste goof sails right through it.
 
 Corrected patch enclosed.
 
 -- 
 Michael Lucas
 mwlucas@blackhelicopters.org
 http://www.blackhelicopters.org/~mwlucas/
 Big Scary Daemons: http://www.oreillynet.com/pub/q/Big_Scary_Daemons
 
 --/9DWx/yDrRhgMJTb
 Content-Type: text/plain; charset=us-ascii
 Content-Disposition: attachment; filename=ports-markup
 
 *** en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml-dist	Mon Nov 12 11:21:53 2001
 --- en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml	Mon Nov 12 14:12:43 2001
 ***************
 *** 2165,2170 ****
 --- 2165,2193 ----
   	    value for <replaceable>n</replaceable>.</para>	  
   	</example>
         </sect3>
 + 
 +       <sect3>
 +         <title>The name of ports</title>
 + 	
 +         <para>You might need to include the name of a program from the
 +           FreeBSD Ports Collection in the documentation.  Use the
 +           <sgmltag>port</sgmltag> tag to identify these.  Since ports
 +           can be installed in any number of locations, only include
 +           the category and the port name; do not include
 +           <filename>/usr/ports</filename>.</para>
 + 
 +         <example>
 +           <title><sgmltag>portname</sgmltag></title>
 + 
 +           <para>Use:</para>
 + 
 +           <programlisting><![ CDATA [<para>Install <port>net/ethereal</port> to view network traffic.</para>]]></programlisting>
 + 
 +           <para>Appearance:</para>
 + 	  
 +           <para>Install <port>net/ethereal</port> to view network traffic.</para>
 +         </example>
 +       </sect3>
       </sect2>
   
       <sect2>
 
 --/9DWx/yDrRhgMJTb--
State-Changed-From-To: open->closed 
State-Changed-By: bmah 
State-Changed-When: Tue Nov 13 10:07:55 PST 2001 
State-Changed-Why:  
Committed with suggested modification.  I also moved the text to the 
DocBook (vs. HTML) section, and added a note that this is a FreeBSD 
extension.  Thankyewverymuch! 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=31934 
>Unformatted:
