Changes

Configuring your development environment

Configuring your development environment

The SME Server source code is checked into CVS at SourceForge. The project has a SourceForge page at https://sourceforge.net/projects/smeserver/. All packages are built using mezzanine, and an overview of mezzanine is provided here: https://wiki.caosity.org/tiki-index.php?page=Package+Maintenance

The SME Server source code is checked into CVS at koozali.org. All packages are built using mezzanine, and an overview of mezzanine is provided here: https://wiki.caosity.org/tiki-index.php?page=Package+Maintenance

Reminder: The SME Server is released under the GPL

Reminder: The SME Server is released under the GPL

The SME Server source code is released under the GPL. You must release the source code to all modifications. If you make improvements, please raise a bug and attach a patch so the change can be discussed and pulled back into the base for everyone to share.

The SME Server source code is released under the GPL. You must release the source code to all modifications. If you make improvements, please raise a bug and attach a patch so the change can be discussed and pulled back into the base for everyone to share.

Do I need a SourceForge account?

Do I need a koozali.org account?

Not really. Only developers who are going to put patches back into CVS and build new packages need SourceForge CVS access. The sources are freely available and patches are gratefully received. Just follow the instructions in this section and attach the patch(es) to the Bugzilla entry, explaining why the change should be made.

Not really. Only developers who are going to put patches back into CVS and build new packages need koozali.org CVS access. The sources are freely available and patches are gratefully received. Just follow the instructions in this section and attach the patch(es) to the Bugzilla entry, explaining why the change should be made.

Add some useful aliases

Add some useful aliases

Mezzanine needs to know to use the SourceForge CVS repository in order to checkout/get or import a package. Once a package is checked out from SourceForge, mezzanine/CVS will remember where it came from and check it back into the same CVS repository. You should not set the CVSROOT environment variable as it makes it too easy to accidentally import code into the wrong CVS repository when working with multiple repositories.

Mezzanine needs to know to use the koozali.org CVS repository in order to checkout/get or import a package. Once a package is checked out from koozali.org, mezzanine/CVS will remember where it came from and check it back into the same CVS repository. You should not set the CVSROOT environment variable as it makes it too easy to accidentally import code into the wrong CVS repository when working with multiple repositories.

Add the following lines to ~/.bashrc (or a file such as /etc/profile.d/smebuild.sh to configure it for all users on this machine):

Add the following lines to ~/.bashrc (or a file such as /etc/profile.d/smebuild.sh to configure it for all users on this machine):

# DO NOT set CVSROOT

# DO NOT set CVSROOT

sf_cvsroot=shell.koozali.org:/cvsroot/smeserver

koozali_cvsroot=shell.koozali.org:/cvs/smeserver

sf_cvsroot_anon=:pserver:anonymous@shell.koozali.org:/cvsroot/smeserver

koozali_cvsroot_anon=:pserver:anonymous@shell.koozali.org:/cvs/smeserver

alias mzgetsf="mzget --dir $sf_cvsroot"

alias mzgetsf="mzget --dir $koozali_cvsroot"

alias mzimportsf="mzimport --dir $sf_cvsroot"

alias mzimportsf="mzimport --dir $koozali_cvsroot"

alias mzgetsf_anon="mzget --dir $sf_cvsroot_anon"

alias mzgetsf_anon="mzget --dir $koozali_cvsroot_anon"

You can now use the mzgetsf_anon (or msgetsf if you have a developer account) to retrieve a package from SourceForge. If you use mzget, you will get an error message to remind you that CVSROOT has not been set, and should not be set. Note that you can use the other mezzanine commands, such as mzclean and mzsync normally as the CVS repository is already known.

You can now use the mzgetsf_anon (or msgetsf if you have a developer account) to retrieve a package from koozali.org. If you use mzget, you will get an error message to remind you that CVSROOT has not been set, and should not be set. Note that you can use the other mezzanine commands, such as mzclean and mzsync normally as the CVS repository is already known.

[gordonr@smebuild tmp]$ mzget smeserver-yum

[gordonr@smebuild tmp]$ mzget smeserver-yum

and so, we want to modify the smeserver-yum package.

and so, we want to modify the smeserver-yum package.

     Note: You can view a complete list of the packages checked into SourceForge CVS http://smeserver.cvs.sourceforge.net/smeserver/. On rare occasions, the sources of particular packages may be slightly out of date as there is a small delay (typically only a few hours) between changes to the developer CVS and the anonymous CVS. In practice, this rarely matters and at worst it requires a merging of your changes with any other recent changes to the package.

     Note: You can view a complete list of the packages checked into koozali.org CVS http://shell.koozali.org/smeserver/. On rare occasions, the sources of particular packages may be slightly out of date as there is a small delay (typically only a few hours) between changes to the developer CVS and the anonymous CVS. In practice, this rarely matters and at worst it requires a merging of your changes with any other recent changes to the package.

All packages on the SME Server ISO/CD must be checked into SourceForge CVS. The only exceptions are packages which come from the following upstream repositories: CentOS and dag.

All packages on the SME Server ISO/CD must be checked into koozali.org CVS. The only exceptions are packages which come from the following upstream repositories: CentOS and dag.

mzgetsf_anon: SourceForge anonymous CVS checkout

mzgetsf_anon: koozali.org anonymous CVS checkout

You can now retrieve one of the packages from SourceForge. In this case, we want to modify the smeserver-yum package, so let's retrieve it from SourceForge:

You can now retrieve one of the packages from koozali.org. In this case, we want to modify the smeserver-yum package, so let's retrieve it from shell.koozali.org:

[gordonr@smebuild smeserver]$ mzgetsf_anon smeserver-yum

[gordonr@smebuild smeserver]$ mzgetsf_anon smeserver-yum

mzclean: Clean out modified files

mzclean: Clean out modified files

Before making changes to a package, you should ensure that you have a clean copy of the latest sources. Remember - other people may also be working on the package and making changes in SourceForge. You can perform a "merge" when you check in your changes, but it is easiest to start with an up-to-date copy. It is even possible that someone else has already fixed the bug you are working on!

Before making changes to a package, you should ensure that you have a clean copy of the latest sources. Remember - other people may also be working on the package and making changes in koozali.org. You can perform a "merge" when you check in your changes, but it is easiest to start with an up-to-date copy. It is even possible that someone else has already fixed the bug you are working on!

[gordonr@smebuild smeserver-yum]$ mzclean

[gordonr@smebuild smeserver-yum]$ mzclean

Please attach the patch(es) and ensure that they are in Unix text format. Patches make it obvious which sections of code have been changed and attaching them ensures that their formatting is preserved.

Please attach the patch(es) and ensure that they are in Unix text format. Patches make it obvious which sections of code have been changed and attaching them ensures that their formatting is preserved.

SourceForge developer CVS access

koozali.org developer CVS access

If you are going to work on many bugs, or wish to help with the many tasks involved in a release, you should create a SourceForge developer account.

If you are going to work on many bugs, or wish to help with the many tasks involved in a release, you should create a koozali.org developer account.

You do not need a SourceForge account in order to do development. You can contribute very effectively by producing patches and attaching them to the Bugzilla entries.

You do not need a koozali.org account in order to do development. You can contribute very effectively by producing patches and attaching them to the Bugzilla entries.

Create a SourceForge account

Create a koozali.org account

     *

     *

       Create a SourceForge user id

       Create a koozali.org user id

     *

     *

       Contact the Development Manager (or one of the other project admins) listed on the SourceForge project page, detailing the packages you would like to work on

       Contact the Development Manager (or one of the other project admins) listed in the Wiki pages, detailing the packages you would like to work on

     *

     *

     *

     *

       Upload an SSH2 key to SourceForge, following the SourceForge documentation: https://sourceforge.net/docs/F02/en/#key_posting

       Upload an SSH2 key to koozali.org, following the documentation: ''to be done''    *

    *

       You will also need to generate another SSH2 key for access to the smebuild build server  

       You will also need to generate another SSH2 key for access to the smebuild build server  

mzgetsf: SourceForge developer CVS checkout

koozali.org developer CVS checkout

Once you have SourceForge CVS access, you can use mzgetsf (instead of mzgetsf_anon) to retrieve the sources. Your copy will be writable and you will be able to put changes back to CVS. When you run mzpatch you should not see an error during the cvs add step.

Once you have koozali.org CVS access, you can use mzgetsf (instead of mzgetsf_anon) to retrieve the sources. Your copy will be writable and you will be able to put changes back to CVS. When you run mzpatch you should not see an error during the cvs add step.

[gordonr@smebuild smeserver-yum]$ mzpatch -n smeserver-yum-1.2.0-ImportKeysComment.patch

[gordonr@smebuild smeserver-yum]$ mzpatch -n smeserver-yum-1.2.0-ImportKeysComment.patch

Official packages have unadorned release tags (e.g. smeserver-yum-1.2.0-05) and must be built on the official build servers. There are three steps involved - build the RPMs (mzbuild), sign the RPMs (rpm --addsign *.rpm) and release the RPMs (release_rpms *.rpm).

Official packages have unadorned release tags (e.g. smeserver-yum-1.2.0-05) and must be built on the official build servers. There are three steps involved - build the RPMs (mzbuild), sign the RPMs (rpm --addsign *.rpm) and release the RPMs (release_rpms *.rpm).

mzimportsf: SourceForge package import

mzimportsf: koozali.org package import

If a package has not already been checked into SourceForge CVS, you can use mzimportsf to import it. You should be careful to run this command from a directory which does not contain an imported package or mezzanine may import the package underneath the existing package.

If a package has not already been checked into koozali.org CVS, you can use mzimportsf to import it. You should be careful to run this command from a directory which does not contain an imported package or mezzanine may import the package underneath the existing package.

mzmerge: Merge changed source RPM

mzmerge: Merge changed source RPM

If a new source RPM has been built without corresponding changes in SourceForge CVS, you can use mzmerge to merge in the changes. This can also be used to merge in changes from a modified upstream package. Care should be exercised with this command, especially if you want to maintain previous patches.

If a new source RPM has been built without corresponding changes in koozali.org CVS, you can use mzmerge to merge in the changes. This can also be used to merge in changes from a modified upstream package. Care should be exercised with this command, especially if you want to maintain previous patches.