Bug 144881

Summary: [patch][handbook] Reference to incorrect manual page
Product: Documentation Reporter: Glen Barber <glen.j.barber>
Component: Books & ArticlesAssignee: Gabor Pali <pgj>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff
none
firewalls.chapter.sgml.txt none

Description Glen Barber 2010-03-19 19:40:03 UTC 
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.

Fix: Patch attached with submission follows:
Comment 1 Gabor Pali freebsd_committer freebsd_triage 2010-08-10 08:32:51 UTC 
Responsible Changed
From-To: freebsd-doc->pgj

Take.
Comment 2 Gabor Pali freebsd_committer freebsd_triage 2010-08-10 10:37:37 UTC 
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
Comment 3 Gabor Pali freebsd_committer freebsd_triage 2010-08-10 10:38:53 UTC 
State Changed
From-To: open->analyzed

The request has been investigated.
Comment 4 Glen Barber 2010-08-10 11:22:19 UTC 
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
Comment 5 Gabor Pali freebsd_committer freebsd_triage 2010-08-10 11:39:44 UTC 
Hi Glen,

This change sounds better :)  Thanks for the update.


:g
Comment 6 pali.gabor 2010-08-10 11:49:57 UTC 
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
Comment 7 dfilter service freebsd_committer freebsd_triage 2010-08-10 13:20:40 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"
Comment 8 Gabor Pali freebsd_committer freebsd_triage 2010-08-10 13:35:00 UTC 
State Changed
From-To: analyzed->closed

The updated patch has been committed with minor modifications.  Thanks 
for the submission!