Dev.rst
No OneTemporary
Actions

Authored By

Unknown

Size

1 KB

Referenced Files

None

Subscribers

None

Dev.rst
View Options

	=============================
	Developing the RoSA Framework
	=============================

	.. contents::
	:local:


	* Coding Style
	* Documentation

	* General docs

	* Sphinx
	* man pages for tools!

	* API

	* Doxygen
	* doc namespaces

	* When and how to update CMake project

	* header files and source files
	* adding libraries, executables


	Using YCM
	=========

	If you happen to use `YCM <https://github.com/Valloric/YouCompleteMe>`_, just
	make a copy of the provided `ycm_extra_conf.py.template` file as
	`.ycm_extra_conf.py` in the RoSA source directory, and set the following two
	variables in it:

	`compilation_database_folder`
	the absolute path of your build directory

	`extra_system_include_dirs`
	any system include directory which might not be searched by `libclang` [1]_.

	You probably want compile with Clang if you use YCM, so run CMake with
	environment variables `CC=clang` and `CXX=clang++` set.

	Also note that header files in the `include` directory are compiled for YCM with
	the compiler flags of a corresponding source file in the `lib` directory, if
	any. Header files in other locations are supposed to have a corresponding source
	file in the same directory.

	Notes
	-----

	* If the project's include directory (`include/rosa`) would ever be changed,
	then the YCM configuration file needs to be adjusted accordingly.

	----

	.. [1] See: https://github.com/Valloric/YouCompleteMe/issues/303; use the
	following command to figure out the used system directories:

	echo \| clang -std=c++11 -v -E -x c++ -