From owner-freebsd-doc  Wed Jan  2 19:48:13 2002
Delivered-To: freebsd-doc@freebsd.org
Received: from rwcrmhc52.attbi.com (rwcrmhc52.attbi.com [216.148.227.88])
	by hub.freebsd.org (Postfix) with ESMTP
	id 3C47237B41B; Wed,  2 Jan 2002 19:48:09 -0800 (PST)
Received: from bmah.dyndns.org ([12.233.149.189]) by rwcrmhc52.attbi.com
          (InterMail vM.4.01.03.27 201-229-121-127-20010626) with ESMTP
          id <20020103034803.EEWJ6450.rwcrmhc52.attbi.com@bmah.dyndns.org>;
          Thu, 3 Jan 2002 03:48:03 +0000
Received: (from bmah@localhost)
	by bmah.dyndns.org (8.11.6/8.11.6) id g033m3U15483;
	Wed, 2 Jan 2002 19:48:03 -0800 (PST)
	(envelope-from bmah)
Message-Id: <200201030348.g033m3U15483@bmah.dyndns.org>
X-Mailer: exmh version 2.5 07/13/2001 with nmh-1.0.4
To: Mario Sergio Fujikawa Ferreira <lioux@FreeBSD.ORG>
Cc: Nik Clayton <nik@FreeBSD.ORG>, Peter Pentchev <roam@ringlet.net>,
	doc@FreeBSD.ORG
Subject: Re: <filename> -> <port> (<protocol>?) 
In-reply-to: <20020103015458.9740.qmail@exxodus.fedaykin.here> 
References: <20011231100926.A3512@straylight.oblivion.bg> <20020102111934.B70243@clan.nothing-going-on.org> <20020103015458.9740.qmail@exxodus.fedaykin.here>
Comments: In-reply-to Mario Sergio Fujikawa Ferreira <lioux@FreeBSD.ORG>
   message dated "Wed, 02 Jan 2002 23:54:36 -0200."
From: "Bruce A. Mah" <bmah@FreeBSD.ORG>
Reply-To: bmah@FreeBSD.ORG
X-Face: g~c`.{#4q0"(V*b#g[i~rXgm*w;:nMfz%_RZLma)UgGN&=j`5vXoU^@n5<Pi&akO)o^8;[r
 %l(8ZHlbF`dD>v4:OO)c["!w)nD/!!~e4Sj7LiT'6*wZ83454H""lb{CC%T37O!!'S$S&D}sem7I[A
 2V%N&+
X-Image-Url: http://www.employees.org/~bmah/Images/bmah-cisco-small.gif
X-Url: http://www.employees.org/~bmah/
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Date: Wed, 02 Jan 2002 19:48:02 -0800
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org

If memory serves me right, Mario Sergio Fujikawa Ferreira wrote:
> On Wed, Jan 02, 2002 at 11:19:34AM +0000, Nik Clayton wrote:
> > On Mon, Dec 31, 2001 at 10:09:26AM +0200, Peter Pentchev wrote:
> > > Is there a reason to use <filename> instead of <port> when referring
> > > to a port?  If not, how about the attached patch?
> > 
> > I'm still uneasy about <port>.  Apart from the ambiguous name:
> > 
> >     <para>The webserver listens on port <port>80</port>.</para>
> > 
> >     <para>The printer is connected to <port>lpt0</port>.</para>
> > 
> > the rest of the world prefers the 'package' nomenclature.
> > 
> > I'd be more comfortable with a 
> > 
> >     <filename class="port">
> > 
> > or
> > 
> >     <filename class="package">
> > 
> > mechanism.  Or perhaps
> > 
> >     <package category="archivers">unzip</package>
> > 
> > or even
> > 
> >     <command package="archivers/unzip">unzip</package>
> 
> 	I tend to agree. The later mechanisms both are not ambiguous
> and help in parsing.
> 	Now that we mention it. What about a <protocol></protocol>
> tag? 
> 	Furthermore, shouldn't we use more <acronym></acronym>?
> 
> 	TCP,IRC,FTP are all protocols and acronyms....

Waitasecond.  I'm a little leery of adding a lot of Yet Another Element
as a non-standard FreeBSD extension to the DocBook DTD.

I felt this way when someone introduced <port></port> but I didn't say
so at the time.  Maybe I should have...although it'd be easy to switch
to something like <filename class="package"></filename>.  Personally,
this is the solution I prefer.

We should take roam's patch, to get the remaining package names into
compliance with our current convention.  *Then* we should see about
getting rid of <port></port> and replacing it with <filename
class="package"> </filename> or some variant thereof.

Bruce.




To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message