The distinction between 'user' and 'developer' is not clear cut. But it is stil usefulDevelopers guide
- 1 Code Style
- 2 Reversions control
- 3 Testing
- 4 Documentation
1 Developers guide
1 Code Style
Merlin++ has a large existing codebase, so not all code meets the current guidelines. New code should, and old code is being gradually be improved.
- Class names should be fully descriptive. e.g. SlicedMacroParticleTracker not SMPTracker.
- Comments should not get in the way of understanding the code - which should be mostly self-explanatory, given the above.
- Use standard C++11, Newer features should be avoided as Scientific Linux with GCC 4.8 is still widely used.
- Prefer modern language features where appropriate, e.g. vectors over C style arrays.
- Prefer references to pointers where possible. For example arguments to methods should take references unless it is an optional parameter which will handle a
- Do not add hard requirements beyond a modern C++ compiler and CMake build system. ROOT, Python, etc must be optional for users.
- Use C++ smart pointers where possible. See unique_ptr, shared_ptr and weak_ptr.
Every use of
newmust have a matching delete, ideally in the same class.
newconsider if it could be avoided, for example by using a regular stack value or using a c++ container class instead of bare arrays.
Merlin++ uses the Allman/BSD brace style (braces on separate lines) and tabs for indentation.
Good formatting is enforced with a git hook that uses the script uncrustify. If you don't have it already, you can install uncrustify from its website or through your linux package manager. The hook must be manually installed by copying or linking it from the
.git/hooksdirectory. From within your git directory run:
cp DeveloperTools/Tools/pre-commit .git/hooks
ln -sr DeveloperTools/Tools/pre-commit .git/hooks
Style can be checked, displayed or fixed with the the
tools/style_wrapper.py check Merlin/AcceleratorComponent.cpp
tools/style_wrapper.py diff Merlin/AcceleratorComponent.cpp
tools/style_wrapper.py fix Merlin/AcceleratorComponent.cpp
If you are using the Eclipse IDE you can install the formatting style from
tools/eclipse_formatting_style.xml. Note that Eclipse does not format identically to uncrustify, so do not run the auto formatter on existing code. Expect the commit hook to occasionally request changes.
2 Reversions control
- Merlin++ source code is managed with GIT or GitHub.
- There is a large amount of documentation at the Git website and GitHub.
- The master branch should always be kept in a good state, buildable and passing all tests.
- New code should be developed in a branch in the developers repo, and a pull request when ready.
- Pull requests should be reviewed by another developer.
2.1 Historic revisons
- The main Merlin++ repository starts in 2009. To see older commits you can graft in the older history. From in side your Merlin++ git directory run:
git remote add Merlin-DESY https://github.com/Sam-Tygier/Merlin-DESY.git git fetch Merlin-DESY echo "ba5f0d0a5eec186a2475c11c11833ea2241d8595 a80fe00a7205b87972f34771f3782fbe31d6d94a" >> .git/info/grafts
2.2 Making changesIf you want to make put some changes you have made to your Merlin++ program into the repository so that other users can benefit from your additions of bug fixes, the procedure is as follows
- You will need to get a github account (if you're an expert you probably have one already, if not then it's useful for lots of stuff)
- You need to get this made a member of the Merlin++ organization. Contact the team who will be happy to help.
- On the github Merlin website, fork the Merlin project. This establishes a version of the code under https://github.com/Your user name /Merlin
- Be absolutely certain that your code is correct and obeys the rules
- Add the relevant routines to git's list of files to be staged. You can do this explicitly file by file, or wholesale for the entire directory, typically by by git add . If doing it wholesale make sure to do it in the source subdirectory, or all the intermediate binary files will get added to the list and mess up the repository. This need only be done once.
- git status is always helpful
- git commit -m "useful message" will commit your changed files to be uploaded. The useful message should briefly explain what you've done and why.
- You may need to remind git of where the files were downloaded from with git remote add origin https://github.com/ your username /Merlin
- Then git push origin master will make the changes in your github repository
- Go to the github website, log in, go to the Merlin repository, click on 'pull requests' and then 'new pull request'. This will start the process of moving the changes in your fork into the mainstream. This requires approval by at least one other developer, who will now be alerted by emails. So it will not be instant.
- Merlin++ use the ctest framework provided by cmake.
- Make sure the variable
BUILD_TESTINGis set to
ON, either with the ccmake tool or by running:
cmake -DBUILD_TESTING=ON ..
- After building run
- Nightly tests can be seen at the CDash server.
- New code should have tests.
- Merlin++ uses Doxygen for documentation. See the Doxygen docs for examples of how to write them.
- These comments will be inserted into the API documentation. Use these to explain what your classes do and how and why they do it - good doxygen is more than just machine generated lists of arguments
- Merlin++ Doxygen comments are made available using the web