[kln2-devel] CVS usage

[Marek W. <mar...@o2...>]

Hi,

The notes below are for those, who do not have much experience
with using cvs, but I think everybody should read them.

I really recommend that you use ssh keys. You can add your
public key at "account options" of your sourceforge page. See
also "Introduction to SSH on SourceForge.net"
https://sourceforge.net/docman/display_doc.php?docid=6841&group_id=1
and "Guide to generating, posting and using SSH keys"
https://sourceforge.net/docman/display_doc.php?docid=761&group_id=1
Note, that it may take few hours for keys to be updated, so you
may need to use your password for a while.

The basic kln2 cvs usage is described in the "for developers"
section of http://klearnnotes2.sourceforge.net/ . I guess, you
should start with "CVS: How to make the usage easier" section
to setup your shell variables and .cvsrc .

The first thing is checkout. Direct checkout [about 4.5 MB] is
better, because you get really the newest code. Or if you
have slow i-net connection, you can download a nightly tarball
[about 0.8 MB].

I suggest that, to test if you can use CVS, everybody adds
himself to AUTHORS file. To do this
1. checkout the CVS tree (or get the nightly tarball)
2. check if anybody edited the file :
        cvs status AUTHORS
if you get something like:
==================================================
File: AUTHORS           Status: Up-to-date
    Working revision:    1.3
    Repository revision: 1.3
your copy is up-to-date. If you get something like
==================================================
File: AUTHORS           Status: Needs Patch
    Working revision:    1.2
    Repository revision: 1.3
someone edited the file, and you should get newer version
before editing it. To do this type:
         cvs update AUTHORS
3. Edit the file. Please add your name or nick and e-mail
just below mine.
4. Commit the edited file back to the repository:
         cvs commit -m"wiecko added his data" AUTHORS
Change the string after -m to any comment you find appropriate
(at least change my nick to yours).
You should see something like this:

Checking in AUTHORS;
/cvsroot/klearnnotes2/klearnnotes2/AUTHORS,v  <--  AUTHORS
new revision: 1.3; previous revision: 1.2
done

If you see something like this:

cvs commit: Up-to-date check failed for `AUTHORS'
cvs [commit aborted]: correct above errors first!

this means someone edited the file and committed his changes
before you did. Well, you can issue
         cvs diff AUTHORS
to see what has changed. But in fact this means that you have
to update your file. Now the magic of cvs works: when you type
         cvs update AUTHORS
your file will be merged with the repository one. You should
get in your working directory a file which has both your
changes and changes committed by the other developer! Look at
the file to check if it is OK. Now you can commit it.
         cvs commit AUTHORS

Note: of course there will be a problem if both developers
edited the same line of code or if someone did a major
reordering of things in the file. But generally, if we are
dealing with minor fixes, parallel working on different parts of
the same file works fine. :) Of course, for safety this should
be avoided if possible.


I hope, that this simple exercise will help you get used to
CVS. Extra info can be found in CVS section of sourceforge site
docs https://sourceforge.net/docman/?group_id=1 . And info
pages (on your local computer) on cvs are quite clear. Of
course, if there is any problem post a message to this mailing
list.

~Marek

-- 

      \/   /|\  Marek Wieckowski
   #####  | | |
  = . . =  \|/  Institute of Theoretical Physics
     U      |   Warsaw University
   / ~ \___ |
  <|   |    |   marek-wie AT o2.pl
   > . <    |   http://www.fuw.edu.pl/~wiecko
  <<___>>   |   http://klearnnotes2.sourceforge.net