Date: Thu, 5 Jul 2001 19:58:21 +0300 (EEST) From: Giorgos Keramidas <keramida@ceid.upatras.gr> To: FreeBSD-gnats-submit@freebsd.org Subject: docs/28731: inconsistent use of <command> and <literal> in committers-guide article for cvs commands Message-ID: <200107051658.f65GwLJ01332@hades.hell.gr>
next in thread | raw e-mail | index | archive | help
>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: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Thu Jul 05 12:30:01 PDT 2001
>Closed-Date:
>Last-Modified:
>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:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200107051658.f65GwLJ01332>