CVSCycle

If you are on Windows, save yourself some time, and download and install TortoiseCVS (restart required) - and do these steps using that instead of the command line.

Initial check-out

To do the initial check-out of HEAD (ie. current version of the main branch) of PloneHelpCenter, do the following - replacing username with your Sourceforge user name:

  cvs -d:ext:username@cvs.sourceforge.net:/cvsroot/collective co PloneHelpCenter

Using a branch

We'll be using a special branch, BootCampSprint-branch, to keep the work done during the sprint. Use the following syntax to get a copy from it:

  cvs -d:ext:username@cvs.sourceforge.net:/cvsroot/collective co -r BootCampSprint-branch PloneHelpCenter

The work/update/commit cycle

After checking out the latest version of PHC, it's time to do some work on it. When you are done with an iteration of work (let's say you add two files, and change two files to reflect other changes), it's time to sync with the main code.

You always update before you commit. The reason for this is that you need to resolve any conflicts that may appear locally before committing. You will not be allowed to commit files with conflicts.

To update:

  cvs up -dP

The -dP means remove empty directories, and Prune files that have been removed upstream. This is what you normally want.

It will then start updating your files against the upstream code tree. You will see stuff like:

  M TODO.txt
  cvs update: Updating Extensions
  cvs update: Updating doc

Et cetera. M means that you have a local modification that needs to be committed, P means that you got an update of that file, and if you are unlucky enough to get a C, you have a conflict - this means that someone else modified the exact same lines as you did, and you will need to look at what his/her changes are compared to your own - and commit a proper version of it, either overriding the changes made, or integrating it in your own code.

After updating, you want to commit your code. The command for this is:

To commit:

  cvs commit

You will be asked for your password, and then CVS launches what is defined as your editor (vi unless you have specified something else in the $EDITOR variable). You need to write a commit message that details what you did, and more importantly, why you did it, and what the effects/changes are. A good commit message will help you (and others!) immensely later on, so take those extra 10 seconds to think about what you should write.

Congratulations! You have committed, and can now do more changes, and start the cycle again.

comments:

location on file system --anmar, Mon, 10 Jan 2005 00:54:30 -0500 reply
note: These CVS commands should be done from within the ZopeInstance?/Products/PloneHelpCenter directory (although probably no one else will be doing this after this time) - I had to mention it in case this is used as a guideline in the future; it confused me (ah, if only I'd been able to do it while in the room with you all)