Bug 29744

Summary: [PATCH] SGML tags and entities in the "Dialup firewalling with FreeBSD" article (minor nit-picking)
Product: Documentation Reporter: ncalvo <ncalvo>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description ncalvo 2001-08-16 05:40:00 UTC 
SGML markup changes to the article "Dialup firewalling with FreeBSD",
which is part of the FreeBSD documentation:

http://www.FreeBSD.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/articles/dialup-firewall/article.sgml

Please note that the enclosed patch is relative to the referenced file
(post pr docs/29086), not the one corresponding to 4.3-RELEASE.

Nothing really important, just minor nit-picking.

Fix: (patch follows; length==54 lines)
How-To-Repeat: N/A
Comment 1 dima 2001-08-16 06:09:29 UTC 
ncalvo <ncalvo@es.freebsd.org> writes:
> --- article.sgml.orig   Thu Aug 16 06:02:35 2001
> +++ article.sgml        Thu Aug 16 06:19:57 2001
> @@ -28,7 +28,7 @@
>  
>      <abstract>
>        <para>This article documents how to setup a firewall using a PPP
> -       dialup with FreeBSD and IPFW, and specifically with firewalling over
> +       dialup with FreeBSD and &man.ipfw.8;, and specifically with firewalling over

I don't know if replacing every instance of "ipfw" with &man.ipfw.8;
is such a good idea.  Some people are concerned that manual page
entites are being abused in this fasion, and since this entire thing
is practically about ipfw, it might be more appropriate to use
<command>, or just leave it alone.

The other fixes look okay.
Comment 2 Murray Stokely freebsd_committer freebsd_triage 2001-09-02 11:21:39 UTC 
State Changed
From-To: open->closed

The change has been made with minor modifications.  Some of the &man 
entities were turned into <command>s instead.  Too many &man entities 
can be an eyesore in either the online or print documents.  Thanks for 
your updates!