cvs.linuxsampler.org

LinuxSampler CVS - Developers Readme

This short Readme is intended for new developers, to inform them about the most important things to know, before commiting stuff to our CVS server the first time.

We have some scripts running on the CVS server whenever stuff is commited to CVS. Mainly for

  1. CVS comment validation
  2. Logging
  3. Showing the CVS comments on the LinuxSampler website

CVS comment validation

If some check of the comment validation scripts fails, the CVS server will impolitely refuse to accept your whole commit batch and will tell you what's wrong about it. In that case correct it as you were told by the error message and try to commit again.

CVS comments on the LinuxSampler website

You can choose either your changes to be shown on the LinuxSampler website or not. If your CVS comment starts at least with one star (*) character, then your changes will automatically be shown on the website, e.g by saying:

* did this
* fixed that
will cause the commit batch to be shown on the website with the provided CVS comment. This is the usual case. But sometimes you might want your changes not to be shown on the website, in this case you just have to omit that star rule, e.g. with the following CVS comment it would not be shown on the website:
- did this
- fixed that
But of course we are all interested to see changes. So better use such silent commits only very rarely. We usually only use it for very trivial changes like, if we forgot to commit file(s) with our recent commit batch or if we just want to fix a typo or something.

CVS modules

Currently (2008-01-03) there are 9 modules on the CVS server (see here for the latest list):

CVS comments of changes against the gigedit, jlscp, jsampler, libgig, liblscp, linuxsampler and qsampler CVS modules are currently shown on the LS website, but still all modules are logged in the same way, so we might decide to retrospectively show old / current changes to other modules on the website as well in future.

Website Content

The web CVS module contains all the web content of our main web server. Feel free to modify the web content, because that's why we established this CVS based web content management. So every developer can freely change the main website content at any time, without having to ask. The webserver performs a sync with CVS once an hour. You can see a timestamp at the bottom of the frontsite which indicates the last time a sync happened. The only exception: please do NOT add large files to the CVS managed web content. We have a dedicated web server where we upload larger files (download.linuxsampler.org) and which is not under CVS control.

ChangeLog files

Don't forget to update the respective ChangeLog file on commits! All our subprojects have a ChangeLog file, so please always update them with a summary of your changes, so we can keep track of all changes.

Experimental and other stuff

Another special CVS module is the one called misc. You can use it for anything that's not "worth" to be in its own, separate CVS module. So you can freely use it for small experimental code or whatever. At the moment it is only used for the all-in-one Windows installer source files.

New subprojects / CVS modules ?

You want to create a new application? A new subproject? Thus a new CVS module? No problem, just tell us before you try to import a new CVS module.

Trouble with account / server ?

Bother Christian!

cvs.linuxsampler.org