From keramida@ceid.upatras.gr  Thu Jul  5 12:23:39 2001
Return-Path: <keramida@ceid.upatras.gr>
Received: from mailsrv.otenet.gr (mailsrv.otenet.gr [195.170.0.5])
	by hub.freebsd.org (Postfix) with ESMTP id 574AD37B401
	for <FreeBSD-gnats-submit@freebsd.org>; Thu,  5 Jul 2001 12:23:38 -0700 (PDT)
	(envelope-from keramida@ceid.upatras.gr)
Received: from hades.hell.gr (patr530-a239.otenet.gr [212.205.215.239])
	by mailsrv.otenet.gr (8.11.1/8.11.1) with ESMTP id f65JNZo10196
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 5 Jul 2001 22:23:35 +0300 (EEST)
Received: (from charon@localhost)
	by hades.hell.gr (8.11.4/8.11.3) id f65GwLJ01332;
	Thu, 5 Jul 2001 19:58:21 +0300 (EEST)
	(envelope-from charon)
Message-Id: <200107051658.f65GwLJ01332@hades.hell.gr>
Date: Thu, 5 Jul 2001 19:58:21 +0300 (EEST)
From: Giorgos Keramidas <keramida@ceid.upatras.gr>
Reply-To: Giorgos Keramidas <keramida@ceid.upatras.gr>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: inconsistent use of <command> and <literal> in committers-guide article for cvs commands
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         28731
>Category:       docs
>Synopsis:       inconsistent use of <command> and <literal> in committers-guide article for cvs commands
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Jul 05 12:30:01 PDT 2001
>Closed-Date:    Wed Jul 11 07:08:52 PDT 2001
>Last-Modified:  Wed Jul 11 07:09:03 PDT 2001
>Originator:     Giorgos Keramidas
>Release:        FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD hades.hell.gr 5.0-CURRENT FreeBSD 5.0-CURRENT #0: Sun Jun 24 18:34:43 EEST 2001 root@hades.hell.gr:/usr/obj/usr/src/sys/CHARON i386

>Description:

The committers-guide article uses either <command>...</command> or
<literal>...</literal> to enclose cvs commands, but there doesn't seem
to be a certain 'pattern' behind their use.

View doc/en_US.ISO8859-1/articles/committers-guide/article.sgml with
less(1) and go to the following lines:

	% less -N doc/en_US.ISO8859-1/articles/committers-guide/article.sgml

     145     <para>If you need to use CVS <command>add</command> and
     146       <command>delete</command> operations in a manner that is
     147       effectively a <quote>mv</quote> operation, then a repository
     148       copy is in order rather than your CVS <command>add</command> and
     149       <command>delete</command>.  In a repository copy, a <link

Here the cvs subcommands `add' and `delete' are enclosed in <command> tags.
However, a few lines below:

     168         <para>Check out a module with the <literal>co</literal> or
     169           <literal>checkout</literal> command.</para>

When an example of a CVS command is included of the form `cvs xxx',
where `xxx' one of the CVS subcommands, things are more easy to
understand.  They're always wrapped in <command>...</command>, with
only *one* exception:

	% grep '>cvs [a-z]\+<' article.sgml | grep -v command
	&prompt.user; <userinput>cvs commit</userinput>

When CVS subcommands are listed as single words though, things get fuzzy.
To see this, use:

	% ( grep 'literal>[a-z]\+<' article.sgml ; grep 'command>[a-z]\+<' article.sgml )

>How-To-Repeat:

>Fix:

We should probably change all the cvs subcommands to <literal>'s or to
<command>'s.  But have them all use the same tag, instead of both.
>Release-Note:
>Audit-Trail:

From: Dima Dorfman <dima@unixfreak.org>
To: Giorgos Keramidas <keramida@ceid.upatras.gr>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/28731: inconsistent use of <command> and <literal> in committers-guide article for cvs commands 
Date: Fri, 06 Jul 2001 05:41:35 -0700

 Giorgos Keramidas <keramida@ceid.upatras.gr> writes:
 > >Fix:
 > 
 > We should probably change all the cvs subcommands to <literal>'s or to
 > <command>'s.  But have them all use the same tag, instead of both.
 
 I think they should be <command>, not <literal>.  mdoc(7) has an .Ic,
 interactive command, macro for these things, but DocBook has no
 equivilent.  <command> sounds better than <literal>.  Would you be
 willing to submit a patch? :-)
 
 Thanks,
 
 					Dima Dorfman
 					dima@unixfreak.org

From: Giorgos Keramidas <keramida@ceid.upatras.gr>
To: Dima Dorfman <dima@unixfreak.org>
Cc: FreeBSD-gnats-submit@freebsd.org
Subject: Re: docs/28731: inconsistent use of <command> and <literal> in committers-guide article for cvs commands
Date: Fri, 6 Jul 2001 15:53:22 +0300

 -----Original Message-----
 From: Dima Dorfman <dima@unixfreak.org>
 Subject: Re: docs/28731: inconsistent use of <command> and <literal> in committers-guide article for cvs commands
 Date: Fri, Jul 06, 2001 at 05:41:35AM -0700
 
 > Giorgos Keramidas <keramida@ceid.upatras.gr> writes:
 > > >Fix:
 > > 
 > > We should probably change all the cvs subcommands to <literal>'s or to
 > > <command>'s.  But have them all use the same tag, instead of both.
 > 
 > I think they should be <command>, not <literal>.  mdoc(7) has an .Ic,
 > interactive command, macro for these things, but DocBook has no
 > equivilent.  <command> sounds better than <literal>.  Would you be
 > willing to submit a patch? :-)
 
 Yup, look for a followup to this PR later this afternoon, when I am
 finished with some other stuff that I have to run after now.
 
 -giorgos
State-Changed-From-To: open->closed 
State-Changed-By: nik 
State-Changed-When: Wed Jul 11 07:08:52 PDT 2001 
State-Changed-Why:  
Fixed, thanks. 

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