Micromegas trigger

This page has some useful working information for those working on the micromegas trigger firmware development. I currently keep a development repository at my local svn. The directory structure in that development repository allows us to keep the projects directory on svn, and thus easily share, concurrently edit and switch between versions of the firmware development code. We also have an official repository, not meant for firmware development, but rather for sharing stable versions of the source code that can then be built into other projects. Instructions on how to work with both versions can be found below.

Working with the firmware development repository

Show how to check out Hide

       cd Projects
       svn co svn+ssh://svn.cern.ch/reps/NSWELX/TriggerProcessor/firmware/mm/trunk firmware
       svn co svn+ssh://svn.cern.ch/reps/NSWELX/TriggerProcessor/software/mm/trunk software

wsvn

Original files

Adding new files to the repository

Get ready to add new files/directories Hide

       cd firmware
       svn propset svn:ignore -R -F .svnignore .
       cd software
       svn propset svn:ignore -R -F .svnignore .

These commands tell svn to ignore files that are locally created by the vivado project and that should not go into svn, since they are not useful (and potentially problematic) for other users.

Then you need to first add the file or directory to the repository as follows.

Add file/directory to repository Hide

    svn add filename

Note, for directories, this adds all files under the directory to the repository (except those listed in the .svnignore file. Now, you need to just commit the files as you would commit any changes to complete the addition of new files/directory.

Committing changed files to the repository

Committing changes Hide

    svn ci -m "Commit message"

This commits every change in your current directory. If you only want to commit a specific file (or set of files), add the filenames after the command above with spaces between filenames.

If you do not remember what you have changed, you may want to check the status of your local directory by doing svn -u status. Any files that have been modified will have an M next to them. Files with a star next to them have been modified in the repository, but not updated in your local directory.

Updating to the latest version of the repository

Creating a tag

Creating a tag Hide

    svn cp svn+ssh://svn.cern.ch/reps/atlas-dlopez/dlopez/MMTrigger/firmware/trunk -r <rev> svn+ssh://svn.cern.ch/reps/atlas-dlopez/dlopez/MMTrigger/firmware/tags/firmware-XX -m "Commit message"

In this case refers to the revision number that you would like to tag, but the -r part can be omitted if you are just tagging the last revision. In that command XX should be a unique number that identifies the tag. You can also tag branch versions easily. Note that branch tags will also be stored in the tags directory, so the command is:

Creating a tag from a branch Hide

    svn cp svn+ssh://svn.cern.ch/reps/atlas-dlopez/dlopez/MMTrigger/firmware/branches/firmware-XX-branch -r <rev> svn+ssh://svn.cern.ch/reps/atlas-dlopez/dlopez/MMTrigger/firmware/tags/firmware-XX-YY -m "Commit message"

In this instance, the directory firmware-XX-branch stores the "trunk" of the branch. XX refers to the tag that the branch originated from.

Creating a branch

Creating a branch Hide

    svn cp svn+ssh://svn.cern.ch/reps/atlas-dlopez/dlopez/MMTrigger/firmware/tags/firmware-XX 
svn+ssh://svn.cern.ch/reps/atlas-dlopez/dlopez/MMTrigger/firmware/branches/firmware-XX-branch -m "Commit message"

After doing this, you need to make sure that your working directory points to that branch as follows.

Switching to a branch you just created Hide

    svn switch svn+ssh://svn.cern.ch/reps/atlas-dlopez/dlopez/MMTrigger/firmware/branches/firmware-XX-branch . 

Working with a branch version and switching between tags and trunk

Switching to a branch or tag in the repository Hide

    svn switch svn+ssh://svn.cern.ch/reps/NSWELX/TriggerProcessor/firmware/mm/branches/firmware-XX-branch . 
   or
   svn switch svn+ssh://svn.cern.ch/reps/NSWELX/TriggerProcessor/firmware/mm/tags/firmware-XX . 
 

If you have modifications in your current directory with respect to the latest committed version, this command may complain, since it does in fact remove all the versioned files in your directory and substitutes them by the ones stored on svn.