CVSERP5 Guideline

Once someone is authorized to modify the cvs repository of erp5, this does not mean that this should do whatever he wants !! Members of a community should respects some simple, but important rules. This document will describes how erp5 users should use CVS.

Becoming a member :

We will be more than glad to welcome new members. But since we can't let anyone to become a new member, we should make make sure that this person is able to make good changes. So for that, we will first accept patchs.

Members :

This is a list of rules that you should respec when you are submitting :

      -- *before committing* : restart you zope and look if nothing is broken !!
      -- Don't forget to add new files if you created new ones.
      -- Update you code before commiting, so you will see if there's some
         conflicts. If you don't update, then the conflict will be submitted
         to the cvs repository, and you could be sure that will broke the
         erp5 of everyone
      -- Commit you change. Please, don't be lazy, it is a very good thing to
         enter a comment, so we can know what you changed.

CVS commands :

This is for users who are not very familiar with cvs. This is also a good thing for experienced users to take a look.

How do you get the code ?

You should look to the following url on savannah.

How do you update your code ?

First go the cvs directory and do :

       cvs update -RdP

This is important to do this, so you will be sure that old files are deleted on your directory.

How do you commit your change ?

Again, you should go to your source code directory and enter :

         cvs commit [directory_name]/[file_name]

At this moment, you will have an editor, so you have to enter a comment describing what you changed.

What can you do if you have a conflict ?

Of course you can edit the file by hand. But sometimes it is more useful to use cervia.

How can I see what I changed ?

cvs update -RdP

And before each file you changed, you will see a M.

cvs diff [directory_name]/[file_name]

Manage skins with zope and cvs :

First of all, you have to set two externals methods : the first one allows to import skins, the second one allows to export skins.

The first external method looks like this :

         id : fs_to_local
         title : Copy FS to Local
         Module Name : ERP5.ImportExportSkins
         Function Name : importSkins

The second external method looks like this :

         id : local_to_fs
         title : Copy Local to FS
         Module Name : ERP5.ImportExportSkins
         Function Name : exportSkins

Then, if you want to commit your local changes to the cvs, and also update your local skins with changes made by other developpers, you should proceed like this :

• Do a Local to FS, so that your changes will be written on your filesystem.
• Then update you cvs code (you can use cervisia or cvs update -RdP)
• Finally, you should do a FS to Local, so that you will get all changes.