Bug 28730

Summary: request for addition of a few more details on 'cvs log' usage to the text of articles/committers-guide
Product: Documentation Reporter: Giorgos Keramidas <keramida>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Giorgos Keramidas 2001-07-05 20:30:01 UTC
        Just a small addition to the text of articles/committers-guide
        that adds a few details regarding the usage of 'cvs log'.
Comment 1 dima 2001-07-06 13:47:54 UTC
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
Comment 2 nik freebsd_committer freebsd_triage 2001-07-11 14:22:07 UTC
State Changed
From-To: open->closed

Committed, thanks.