From keramida@ceid.upatras.gr  Thu Jul  5 12:23:37 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 7600E37B403
	for <FreeBSD-gnats-submit@freebsd.org>; Thu,  5 Jul 2001 12:23:36 -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 f65JNXo10160
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 5 Jul 2001 22:23:33 +0300 (EEST)
Received: (from charon@localhost)
	by hades.hell.gr (8.11.4/8.11.3) id f65InCv02466;
	Thu, 5 Jul 2001 21:49:12 +0300 (EEST)
	(envelope-from charon)
Message-Id: <200107051849.f65InCv02466@hades.hell.gr>
Date: Thu, 5 Jul 2001 21:49:12 +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: request for addition of a few more details on 'cvs log' usage to the text of articles/committers-guide
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         28730
>Category:       docs
>Synopsis:       request for addition of a few more details on 'cvs log' usage to the text of articles/committers-guide
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Thu Jul 05 12:30:01 PDT 2001
>Closed-Date:    Wed Jul 11 06:22:07 PDT 2001
>Last-Modified:  Wed Jul 11 06:22:17 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:

        Just a small addition to the text of articles/committers-guide
        that adds a few details regarding the usage of 'cvs log'.

>How-To-Repeat:

>Fix:

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/05 18:41:05
@@ -582,6 +582,37 @@
 
         <!-- XXX needs more details -->
         <screen>&prompt.user; <userinput>cvs log shazam</userinput></screen>
+
+        <para>If <filename>shazam</filename> is a file, this will print a
+          <emphasis>header</emphasis> with information about this file, such
+          as where in the repository this file is stored, which revision is
+          the <literal>HEAD</literal> for this file, what branches this file
+          is in, and any tags that are valid for this file.  Then, for each
+          revision of this file, a log message is printed.  This includes
+          the date and time of the commit, who did the commit, how many lines
+          were added and/or deleted, and finally the log message that the
+          committer who did the change wrote.</para>
+
+        <para>If <filename>shazam</filename> is a directory, then the log
+          information described above is printed for each file in the
+          directory in turn.  Unless you give the <option>-l</option> to
+          <literal>log</literal>, the log for all subdirectories of
+          <filename>shazam</filename> is printed too, in a recursive
+          manner.</para>
+
+        <para>Use the <literal>log</literal> command to view the history of
+          one or more files, as it's stored in the CVS repository.  You can
+          even use it to view the log message of a specific revision, if you
+          add the <option>-r<replaceable>rev</replaceable></option> to the
+          <literal>log</literal> command:</para>
+
+        <screen>&prompt.user; <userinput>cvs log -r1.2 shazam</userinput></screen>
+
+        <para>This will print only the log message for revision
+          <literal>1.2</literal> of file <filename>shazam</filename> if it is
+          a file, or the log message for revision <literal>1.2</literal> of
+          each file under <filename>shazam</filename> if it is a
+          directory.</para>
       </listitem>
 
       <listitem>
>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/28730: request for addition of a few more details on 'cvs log' usage to the text of articles/committers-guide 
Date: Fri, 06 Jul 2001 05:47:54 -0700

 Giorgos Keramidas <keramida@ceid.upatras.gr> writes:
 > @@ -582,6 +582,37 @@
 >  
 >          <!-- XXX needs more details -->
 
 This can probably go now :-).
 
 >          <screen>&prompt.user; <userinput>cvs log shazam</userinput></screen>
 > +
 > +        <para>If <filename>shazam</filename> is a file, this will print a
 > +          <emphasis>header</emphasis> with information about this file, such
 > +          as where in the repository this file is stored, which revision is
 > +          the <literal>HEAD</literal> for this file, what branches this file
 > +          is in, and any tags that are valid for this file.  Then, for each
 > +          revision of this file, a log message is printed.  This includes
 > +          the date and time of the commit, who did the commit, how many lines
 > +          were added and/or deleted, and finally the log message that the
 > +          committer who did the change wrote.</para>
 > +
 > +        <para>If <filename>shazam</filename> is a directory, then the log
 > +          information described above is printed for each file in the
 > +          directory in turn.  Unless you give the <option>-l</option> to
 > +          <literal>log</literal>, the log for all subdirectories of
 
 <command>, please.
 
 > +          <filename>shazam</filename> is printed too, in a recursive
 > +          manner.</para>
 > +
 > +        <para>Use the <literal>log</literal> command to view the history of
 
 Ditto.
 
 > +          one or more files, as it's stored in the CVS repository.  You can
 > +          even use it to view the log message of a specific revision, if you
 > +          add the <option>-r<replaceable>rev</replaceable></option> to the
 > +          <literal>log</literal> command:</para>
 
 Ditto.
 
 > +
 > +        <screen>&prompt.user; <userinput>cvs log -r1.2 shazam</userinput></screen>
 
 I would write this like so:
 
 <screen>&prompt.user; <userinput><command>cvs</command> log <option>-r1.2</option> <filename>shazam</filename></userinput></screen>
 
 Other than that, looks great.  Thanks!
 
 					Dima Dorfman
 					dima@unixfreak.org
State-Changed-From-To: open->closed 
State-Changed-By: nik 
State-Changed-When: Wed Jul 11 06:22:07 PDT 2001 
State-Changed-Why:  
Committed, thanks. 

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