/doc/doxygen/additional_doc/related_tools.dox
http://github.com/dladd/cm · Unknown · 49 lines · 47 code · 2 blank · 0 comment · 0 complexity · 45fc35aac4e3d20b41061762a46faa4b MD5 · raw file
- /*!
- \page tools Related Tools
- \section tracker Project Tracker
- The opencmiss project tracker is hosted by the Physiome project's Tracker
- \subsection tracker_tips Tips
- - To view openCMISS tracker items, go to https://tracker.physiomeproject.org/buglist.cgi?query_format=advanced&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&product=openCMISS-cm
- - To add a tracker item: https://tracker.physiomeproject.org/enter_bug.cgi?classification=openCMISS-cm
- - Set preferences in the tracker to shadow/watch the opencmiss@physiomeproject.org user. It is a default CC on openCMISS items, and that way you can set your preferences as to which bugmail you get, and have all new openCMISS tracker items.
- - There is an RSS feed link for any search result, so if you do a search for openCMISS (Advanced search, then choose openCMISS from "Classification"), you can use the RSS feed, and CC yourself to tracker items of interest.
- \section doxygen Doxygen
- The programmer documentation is managed by Doxygen. The html version of doxygen is hosted in http://cmiss.bioeng.auckland.ac.nz/OpenCMISS/doc/doxygen/html/.
- \subsection doxygen_tips Tips
- - Can be downloaded from http://www.stack.nl/~dimitri/doxygen/
- - Suggested Doxygen version is 1.5.6. (Currently there are some problems with 1.5.7 & 1.5.8)
- - To generate html and latex versions, go to <path_to_your_opencmiss_folder>/doc/doxygen and run doxygen under that directory. There will be two folders html and latex generated.
- - To generate pdf version, use some latex to pdf conversion tools, e.g pdflatex. In the latex folder, run "pdflatex refman.tex" and the refman.pdf file will be produced.
- - By default dot is enabled. Dot tool is part of Graphviz, a graph visualization toolkit from AT&T and Lucent Bell Labs. To reduce number of files generated, disable the dot tool by setting HAVE_DOT=NO in <path_to_your_opencmiss_folder>/doc/doxygen/Doxyfile.
- \section buildbot Buildbot
- Buildbot is used as the automatic building and testing tool for the openCMISS project. Currently, the buildbot master is hosted at http://autotest.bioeng.auckland.ac.nz:8888/. Refer to the buildbot manual for the buildmaster and buildslave initial set up.
- \subsection buildbot_steps To add the addition buildslave for OpenCMISS
- -# Install Buildbot and all required installations for OpenCMISS
- -# Make sure that all build dependencies are met
- -# Accept the ssl certificate permanently: in terminal, use \code svn list https://svn.physiomeproject.org/svn/opencmissextras/cm/trunk/external/ \endcode and select p.
- -# Send an email to opencmiss-developers@lists.sourceforge.net with the following information
- - Name (e.g. Joe Bloggs)
- - OS - Name, Version & Architecture ( CentOS 5 64bit)
- - Compiler name, version
- -# When you get a response, you will receive a build slave name (e.g. centos5_64) and a password (e.g. PaSSw0rd)
- -# Follow the following slave instructions.
- \code
- buildbot create-slave [slave dir] autotest.bioeng.auckland.ac.nz:9999 [slavename] [password]
- cd [slave dir]/info
- echo "Put Your Name Here < and some cryptic email text> > admin
- echo OpenCMISS - Name Version & Architecture `uname -a` > host
- cat admin host
- cd [slave dir]
- # Set the OPENCMISSEXTRAS_ROOT, OPENCMISS_ROOT, and PATH environment variables in the Makefile
- make start
- tail -f [slave dir]/twistd.log
- \endcode
- \subsection buildbot_tips Tips
- - Manual and downloads from http://buildbot.net/trac
- - It could contain one build master(machine to trigger the builds on different build slaves and deliver information about the build results through protocols like HTTP, mail)
- - It could contain several build slaves (obtain codes from svn repository and do the build under build master's instructions).
- - Build master and build slaves can be on the same machine.
- - The svn update for buildbot allows source code update from other branches or previous revisions. To do that, in the svn builder page, either enter the branch path from cm directory(exclusive) in the "Branch to build" text field or enter the revision number in the "Revision to build" text field.
- */