[alan@gospelcom.net: Re: [PEG-devel] 0.6.5]

[alan r. <al...@go...>]

Accidentally sent this just to Topher the first try...

----- Forwarded message from alan ritari <al...@go...> -----

Date: Fri, 22 Jun 2001 10:29:58 -0400
From: alan ritari <al...@go...>
To: Topher <to...@wc...>
Subject: Re: [PEG-devel] 0.6.5

> Ok, here's what I posted to Alan off-list.  Alan, I don't want to make you
> feel like you have to teach us all CVS, but if you're up to answering
> simple questions on the list, that would be cool.
> 
> Peter told me all I should really need is 4 commands that I don't have
> here, but it was commit, update, and whatever to get them out.

A while ago I wrote a kind of "quick start" document for my fellow
employees.  You'll need to substitute out all the gospelcom-specific paths
and servers of course, but I think it covers the essentials.  I'll paste it
below.  Does it help?

> I'm interested in knowing how to make it insert version numbers for me in
> the INSTALL files etc,

First I need to clarify that there is a difference between CVS version
numbers and release version numbers.  To have CVS visually record it's
internal version number, put $Id$ in your script header somewhere.  CVS
won't really manage release numbers for you as you'd announce them in
freshmeat, BUT you can do some stuff with tagging batches of files as a
release, FWIW.  Look for "tag" in the manual:
http://cvshome.org/docs/manual/cvs.html

> and whether or not I can make CVS spit out a tar.gz
> of the new version, or if I have to check out each file and make it
> myself.

You'll need to make the tarballs yourself, but that's trivial.  Just do
this:

cvs checkout peg; tar cvzf peg-1.0.tgz peg

alan ritari
al...@go...
--
When encryption is outlawed, ?o'AZ-,++o+i++##4AoA+-/-C++bI+/.+~
(seen on slashdot.org)

-----BEGIN README-----


$Header: /usr/local/src/gcn/cvs-docs/README,v 1.5 2000/06/13 15:26:25 alan Exp $

========================
CVS Documentation README
========================


This is the main Gospelcom documentation for CVS.  As a general rule of thumb, 
all source code for a project and it's related documentation should be placed 
in a cvs repository.  This includes source files, man pages, requirements docs,
architecture docs, etc.

To view all cvs repositories: tech.gospelcom.net/cgi-bin/cvsweb
To checkout specific repositories: see "Getting started"


Getting started
===============

The first thing you need to do is set your environment variables.  Set the 
following in .bash_profile (or another shell's equivalent)...

CVSROOT=(username)@tech.gospelcom.net:/usr/local/src/gcn
CVS_RSH=ssh

export CVSROOT CVS_RSH

To checkout a repository, type:
> cvs checkout REPOSITORY_NAME


Creating a repository
=====================

The next thing you'll probably want to do is check in some of 
your own scripts.  To do this you'll use the cvs import command.

For example, to create a new project repository and import the contents of 
the current directory, you would type...

> cvs import REPOSITORY_NAME YOUR_USERNAME initial

The REPOSITORY_NAME is the directory you want to put your scripts in.
The YOUR_USERNAME is your username, oddly enough.  "initial" refers to the 
type of import.


Adding/changing files
=====================

First, you must have a local, working copy of the repository.  If you don't
have one yet:
> cvs checkout REPOSITORY_NAME
If you have a copy checked out, but want to make sure it is current:
> cd REPOSITORY_NAME
> cvs update

Adding a new file to an existing repository is a two step process:
> cvs add FOO.pl
> cvs commit FOO.pl
Make sure you type a change message when prompted!

Changing an existing file involves copying the new file into place in your
local working repository.  Then:
> cvs commit FOO.pl
Make sure you type a change message when prompted!


Checking binary files
=====================

Some types of files (images, some requirements docs, etc) may be in a binary
format.  In order to preserve the integrity of these files, you must check
them in as binary files:
> cvs add -kb foo.jpg


CVS Style for Gospelcom
=======================

Source code files should contain two essential cvs tags to help track their
revisions: Header and Log.  The standard gospelcom header contains both
of these, so you should be set.


----------------------
Revision History:
$Log: README,v $
Revision 1.5  2000/06/13 15:26:25  alan
Fixed outdated CVSROOT path.

Revision 1.4  2000/06/13 12:46:26  alan
Added "adding/changing"

Revision 1.3  2000/06/13 12:40:49  alan
Added "getting started" and "style".

Revision 1.2  1998/06/27 17:08:34  eric
Added CVS Logging


----- End forwarded message -----
alan ritari
al...@go...
--
If you want to know what God thinks of money, just look at the people he
gave it to.  -- Dorothy Parker