From nobody@FreeBSD.org  Fri Mar 19 19:32:50 2010
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 DFF69106564A
	for <freebsd-gnats-submit@FreeBSD.org>; Fri, 19 Mar 2010 19:32:50 +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 CED7C8FC19
	for <freebsd-gnats-submit@FreeBSD.org>; Fri, 19 Mar 2010 19:32:50 +0000 (UTC)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id o2JJWo8e050863
	for <freebsd-gnats-submit@FreeBSD.org>; Fri, 19 Mar 2010 19:32:50 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id o2JJWofu050862;
	Fri, 19 Mar 2010 19:32:50 GMT
	(envelope-from nobody)
Message-Id: <201003191932.o2JJWofu050862@www.freebsd.org>
Date: Fri, 19 Mar 2010 19:32:50 GMT
From: Glen Barber <glen.j.barber@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch][handbook] Reference to incorrect manual page
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         144881
>Category:       docs
>Synopsis:       [patch][handbook] Reference to incorrect manual page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    pgj
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Mar 19 19:40:03 UTC 2010
>Closed-Date:    Tue Aug 10 12:35:36 UTC 2010
>Last-Modified:  Tue Aug 10 12:35:36 UTC 2010
>Originator:     Glen Barber
>Release:        8.0-STABLE
>Organization:
>Environment:
FreeBSD orion 8.0-STABLE FreeBSD 8.0-STABLE #43 r205084: Fri Mar 12 11:27:30 EST 2010     root@orion:/usr/obj/usr/src/sys/ORION  amd64
>Description:
Section 30.5.8 of the Handbook states:
 
If the packet is a TCP packet, there will be an additional field starting with a hyphen followed by letters corresponding to any flags that were set. See the ipmon(8) manual page for a list of letters and their flags.
 
However, ipmon(8) directs the user to ipf.conf(5), so let's reference 
that directly instead.
>How-To-Repeat:

>Fix:


Patch attached with submission follows:

--- /usr/doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml.orig	2009-12-11 15:13:07.000000000 -0500
+++ /usr/doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml	2010-03-19 14:43:17.000000000 -0400
@@ -515,8 +515,8 @@
       <acronym>NAT</acronym> rules can be set or deleted with the
       &man.ipnat.1; utility.  The &man.ipfstat.8; utility can print
       run-time statistics for the kernel parts of IPFILTER.  The
-      &man.ipmon.8; program can log IPFILTER actions to the system log
-      files.</para>
+      &man.ipf.conf.5; program can log IPFILTER actions to the system
+      log files.</para>
 
     <para>IPF was originally written using a rule processing logic of
       <quote>the last matching rule wins</quote> and used only


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->pgj 
Responsible-Changed-By: pgj 
Responsible-Changed-When: Tue Aug 10 07:32:51 UTC 2010 
Responsible-Changed-Why:  
Take. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=144881 
State-Changed-From-To: open->analyzed 
State-Changed-By: pgj 
State-Changed-When: Tue Aug 10 09:38:53 UTC 2010 
State-Changed-Why:  
The request has been investigated. 

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

From: Gabor PALI <pgj@FreeBSD.org>
To: bug-followup@FreeBSD.org, glen.j.barber@gmail.com
Cc:  
Subject: Re: docs/144881: [patch][handbook] Reference to incorrect manual page
Date: Tue, 10 Aug 2010 11:37:37 +0200

 Hello Glen,
 
 I think you are wrong, since the sentence in questions says (without
 references): "The ipmon(8) program can log IPFILTER actions to the
 system log files.", i.e. it discusses the program itself, not its
 configuration file.  The reference to the manual page is just a hidden
 link to the corresponding program's description.  Thus it does not
 really matter what the real configuration file is, so the change would
 result the following awkward text: "The ipf.conf(5) program can log
 IPFILTER actions to the system log files."
 
 I would close this PR with no changes.
 
 
 :g

From: Glen Barber <glen.j.barber@gmail.com>
To: Gabor PALI <pgj@FreeBSD.org>
Cc: bug-followup@FreeBSD.org
Subject: Re: docs/144881: [patch][handbook] Reference to incorrect manual
 page
Date: Tue, 10 Aug 2010 06:22:19 -0400

 This is a multi-part message in MIME format.
 --------------040904060007050104060903
 Content-Type: text/plain; charset=ISO-8859-1
 Content-Transfer-Encoding: 7bit
 
 On 8/10/10 5:37 AM, Gabor PALI wrote:
 > Hello Glen,
 > 
 > I think you are wrong, since the sentence in questions says (without
 > references): "The ipmon(8) program can log IPFILTER actions to the
 > system log files.", i.e. it discusses the program itself, not its
 > configuration file.  The reference to the manual page is just a hidden
 > link to the corresponding program's description.  Thus it does not
 > really matter what the real configuration file is, so the change would
 > result the following awkward text: "The ipf.conf(5) program can log
 > IPFILTER actions to the system log files."
 > 
 > I would close this PR with no changes.
 > 
 > 
 
 Hello Gabor,
 
 You are correct that this patch is wrong.  I had mistakenly changed the
 wrong line - please see the attached patch, which makes the change I had
 intended initially.
 
 Best regards,
 
 -- 
 Glen Barber
 
 --------------040904060007050104060903
 Content-Type: text/plain;
  name="firewalls.chapter.sgml.txt"
 Content-Transfer-Encoding: 7bit
 Content-Disposition: attachment;
  filename="firewalls.chapter.sgml.txt"
 
 --- doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml.orig	2010-07-19 17:03:42.734654000 -0400
 +++ doc/en_US.ISO8859-1/books/handbook/firewalls/chapter.sgml	2010-08-10 06:15:01.469976339 -0400
 @@ -932,7 +932,7 @@
        <para>If the packet is a <acronym>TCP</acronym> packet, there
  	will be an additional field starting with a hyphen followed by
  	letters corresponding to any flags that were set.  See the
 -	&man.ipmon.8; manual page for a list of letters and their
 +	&man.ipf.conf.5; manual page for a list of letters and their
  	flags.</para>
  
        <para>If the packet is an ICMP packet, there will be two fields
 
 --------------040904060007050104060903--

From: Gabor PALI <pgj@FreeBSD.org>
To: bug-followup@FreeBSD.org, glen.j.barber@gmail.com
Cc:  
Subject: Re: docs/144881: [patch][handbook] Reference to incorrect manual page
Date: Tue, 10 Aug 2010 12:39:44 +0200

 Hi Glen,
 
 This change sounds better :)  Thanks for the update.
 
 
 :g

From: =?ISO-8859-1?Q?P=C1LI_G=E1bor_J=E1nos?= <pali.gabor@googlemail.com>
To: bug-followup@FreeBSD.org, glen.j.barber@gmail.com
Cc:  
Subject: Re: docs/144881: [patch][handbook] Reference to incorrect manual page
Date: Tue, 10 Aug 2010 12:49:57 +0200

 Glen,
 
 I have found that ipf(5) links to the same page, while using
 ipf.conf(5) is not valid since it has no manrefs entry.  So I would
 use ipf(5) instead of ipf.conf(8).
 
 
 :g

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/144881: commit references a PR
Date: Tue, 10 Aug 2010 12:20:40 +0000 (UTC)

 pgj         2010-08-10 12:20:24 UTC
 
   FreeBSD doc repository
 
   Modified files:
     en_US.ISO8859-1/books/handbook/firewalls chapter.sgml 
   Log:
   - Reference ipf(5) instead of ipmon(8) because it is a better
     source of information regarding logging TCP packets, and it already
     points to that manual page
   
   PR:             docs/144881
   Submitted by:   Glen Barber <glen.j.barber@gmail.com>
   
   Revision  Changes    Path
   1.94      +1 -1      doc/en_US.ISO8859-1/books/handbook/firewalls/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: analyzed->closed 
State-Changed-By: pgj 
State-Changed-When: Tue Aug 10 12:35:00 UTC 2010 
State-Changed-Why:  
The updated patch has been committed with minor modifications.  Thanks 
for the submission! 

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