From keramida@ceid.upatras.gr  Fri Jul  6 11:33:23 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 7C13A37B407
	for <FreeBSD-gnats-submit@freebsd.org>; Fri,  6 Jul 2001 11:33:22 -0700 (PDT)
	(envelope-from keramida@ceid.upatras.gr)
Received: from hades.hell.gr (patr530-a016.otenet.gr [212.205.215.16])
	by mailsrv.otenet.gr (8.11.1/8.11.1) with ESMTP id f66IXJh06095
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 6 Jul 2001 21:33:19 +0300 (EEST)
Received: (from charon@localhost)
	by hades.hell.gr (8.11.4/8.11.4) id f66Equr02390
	for FreeBSD-gnats-submit@freebsd.org; Fri, 6 Jul 2001 17:52:56 +0300 (EEST)
	(envelope-from keramida@ceid.upatras.gr)
Message-Id: <20010706175255.A2336@hades.hell.gr>
Date: Fri, 6 Jul 2001 17:52:56 +0300
From: Giorgos Keramidas <keramida@ceid.upatras.gr>
To: FreeBSD-gnats-submit@freebsd.org
In-Reply-To: <200107051658.f65GwLJ01332@hades.hell.gr>; from keramida@ceid.upatras.gr on Thu, Jul 05, 2001 at 07:58:21PM +0300
Subject: Re: inconsistent use of <command> and <literal> in committers-guide article for cvs commands
References: <200107051658.f65GwLJ01332@hades.hell.gr>

>Number:         28780
>Category:       docs
>Synopsis:       Re: inconsistent use of <command> and <literal> in committers-guide article for cvs commands
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Jul 06 11:40:02 PDT 2001
>Closed-Date:    Mon Jul 16 16:15:05 PDT 2001
>Last-Modified:  Wed Oct 26 05:50:15 GMT 2005
>Originator:     
>Release:        
>Organization:
>Environment:
>Description:
 Dima Dorfman <dima@unixfreak.org> wrote:
 >  
 >  I think they should be <command>, not <literal>.  ..
 >  Would you be willing to submit a patch? :-)
 
 And here's the patch that changes all the instances of <literal> that
 wrap cvs commands to <command>.
 
 Index: en_US.ISO8859-1/articles/committers-guide/article.sgml
 ===================================================================
 RCS file: /home/ncvs/doc/en_US.ISO8859-1/articles/committers-guide/article.sgml,v
 retrieving revision 1.73
 diff -u -r1.73 article.sgml
 --- en_US.ISO8859-1/articles/committers-guide/article.sgml	2001/06/22 08:18:55	1.73
 +++ en_US.ISO8859-1/articles/committers-guide/article.sgml	2001/07/06 14:30:11
 @@ -165,8 +165,8 @@
  
      <orderedlist>
        <listitem>
 -        <para>Check out a module with the <literal>co</literal> or
 -	  <literal>checkout</literal> command.</para>
 +        <para>Check out a module with the <command>co</command> or
 +	  <command>checkout</command> command.</para>
  
          <screen>&prompt.user; <userinput>cvs checkout shazam</userinput></screen>
  
 @@ -306,7 +306,7 @@
  
        <listitem>
          <para>Check the status of checked-out files with the
 -          <literal>status</literal> command.</para>
 +          <command>status</command> command.</para>
  
          <screen>&prompt.user; <userinput>cvs status shazam</userinput></screen>
  
 @@ -358,7 +358,7 @@
  
        <listitem>
          <para>Once you've checked something out, update it with the
 -          <literal>update</literal> command.</para>
 +          <command>update</command> command.</para>
  
          <screen>&prompt.user; <userinput>cvs update shazam</userinput></screen>
  
 @@ -370,7 +370,7 @@
            stuff is going on.</para>
  
          <para>Useful options, in addition to those listed above for
 -          <literal>checkout</literal>:</para>
 +          <command>checkout</command>:</para>
  
          <informaltable frame="none">
            <tgroup cols=2>
 @@ -528,7 +528,7 @@
  
        <listitem>
          <para>View differences between the local version and the
 -          repository version with the <literal>diff</literal>
 +          repository version with the <command>diff</command>
            command.</para>
  
          <screen>&prompt.user; <userinput>cvs diff shazam</userinput></screen>
 @@ -569,7 +569,7 @@
          <para>You can also diff against a different version
            than the one you checked out by specifying a version
            with <option>-r</option> or <option>-D</option> as in
 -          <literal>checkout</literal> or <literal>update</literal>,
 +          <command>checkout</command> or <command>update</command>,
            or even view the diffs between two arbitrary versions
            (with no regard for what you have locally) by specifying
            <emphasis>two</emphasis> versions with <option>-r</option> or
 @@ -577,7 +577,7 @@
        </listitem>
  
        <listitem>
 -        <para>View log entries with the <literal>log</literal>
 +        <para>View log entries with the <command>log</command>
            command.</para>
  
          <!-- XXX needs more details -->
 @@ -585,7 +585,7 @@
        </listitem>
  
        <listitem>
 -        <para>See who did what with the <literal>annotate</literal> command.
 +        <para>See who did what with the <command>annotate</command> command.
            This command shows you each line of the specified file or
            files, along with which user most recently changed that
            line.</para>
 @@ -594,7 +594,7 @@
        </listitem>
  
        <listitem>
 -        <para>Add new files with the <literal>add</literal> command.</para>
 +        <para>Add new files with the <command>add</command> command.</para>
  
          <para>Create the file, <command>cvs add</command> it, then
            <command>cvs commit</command> it.</para>
 @@ -605,15 +605,15 @@
        </listitem>
  
        <listitem>
 -        <para>Remove obsolete files with the <literal>remove</literal> command.</para>
 +        <para>Remove obsolete files with the <command>remove</command> command.</para>
  
          <para>Remove the file, then <command>cvs rm</command> it, then
            <command>cvs commit</command> it.</para>
        </listitem>
  
        <listitem>
 -        <para>Commit with the <literal>commit</literal> or
 -          <literal>checkin</literal> command.</para>
 +        <para>Commit with the <command>commit</command> or
 +          <command>checkin</command> command.</para>
  
          <table frame="none">
  	  <title>Useful <command>cvs commit</command> options</title>
>How-To-Repeat:
>Fix:
>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->closed 
State-Changed-By: mikeh 
State-Changed-When: Mon Jul 16 16:15:05 PDT 2001 
State-Changed-Why:  
Appears to have been a followup to docs/28731. 


Responsible-Changed-From-To: gnats-admin->freebsd-doc 
Responsible-Changed-By: mikeh 
Responsible-Changed-When: Mon Jul 16 16:15:05 PDT 2001 
Responsible-Changed-Why:  
Misfiled. 

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