bv_maker

Just run:

bv_maker

should be enough in most cases.

Help of the commandline

Usage: bv_maker [options] [ command [command options] ]...

This program is for the management of source retrieval, configuration and compilation of BrainVISA projects.

In order to work, the commands svn and svnadmin must be installed on your system. On some Linux systems they are in two separate packages (e.g. subversion and subversion-tools).

Commands:

  • info: Just output info about configured components.
  • sources: Create or updated selected sources directories from Subversion repository.
  • configure: Create and configure selected build directories with CMake.
  • build: compile all selected build directories.
  • doc: Generate documentation (sphinx, doxygen, docbook, epydoc).
  • testref: Execute tests in a special mode to generate machine-specific reference files (this is needed by some tests).
  • test: Execute tests using ctest.
  • pack: Generate binary packages.
  • install_pack: Install binary packages.
  • testref_pack: Create the machine-specific reference files for tests in installed binary package.
  • test_pack: Run tests in installed binary packages.

To get help for a specific command, use -h option of the command. Example: “bv_maker build -h”.

To get help on how to configure and write a bv_maker configuration file, see:

http://brainvisa.info/brainvisa-cmake/compile_existing.html

config file syntax:

http://brainvisa.info/brainvisa-cmake/configuration.html

and more generally:

http://brainvisa.info/brainvisa-cmake/

Options:
-h, --help show this help message and exit
-d DIR, --directory=DIR
 Restrict actions to a selected directory. May be used several times to process several directories.
-c CONFIG, --config=CONFIG
 specify configuration file. Default =”/home/riviere/.brainvisa/bv_maker.cfg”
-s DIR, --sources=DIR
 directory containing sources
-b DIR, --build=DIR
 build directory
--username=USERNAME
 specify user login to use with the svn server
-e, --email Use email notification (if configured in the general section of the configuration file)
--disable-jenkins
 disable Jenkins server logging
-v, --verbose show as much information as possible

Info step

Usage: bv_maker [global options] info [options]

Display information about configuration, sources directories and build directories.
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, and “configure build” for build sections

Sources step

Usage: bv_maker [global options] sources [options]

Create or updated selected sources directories from Subversion repository.
Options:
-h, --help show this help message and exit
--no-svn don’t update svn sources
--no-git don’t update git sources
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, and “configure build” for build sections

Configure step

Usage: bv_maker [global options] configure [options]

Create or updated selected build directories.
Options:
-h, --help show this help message and exit
-c, --clean clean build tree (using bv_clean_build_tree -d) before configuring
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, and “configure build” for build sections

Build step

Usage: bv_maker [global options] configure [options]

Compile selected build directories.
Options:
-h, --help show this help message and exit
-c, --clean clean build tree (using bv_clean_build_tree -b) before building
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, and “configure build” for build sections

Doc step

Usage: bv_maker [global options] doc [options]

Generate documentation (docbook, epydoc, doxygen).
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, and “configure build” for build sections

Testref step

Usage: bv_maker [global options] testref

Executes tests in the testref mode (used to generate reference files).
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, and “configure build” for build sections

Test step

Usage: bv_maker [global options] test

Executes ctest.
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, and “configure build” for build sections
-t CTEST_OPTIONS, --ctest_options=CTEST_OPTIONS
 options passed to ctest (ex: “-VV -R carto*”). Same as the configuration option ctest_options but specified at runtime. The commandline option here overrides the bv_maker.cfg options.

Pack step

Usage: bv_maker [global options] pack [options]

Make installer package for the selected build directory.
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, “configure build” for build sections.

Install_pack step

Usage: bv_maker [global options] install_pack [options]

Install a binary package for the selected build directory.
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, “configure build” for build sections.

Testref_pack step

Usage: bv_maker [global options] testref_pack [options]

Create test reference files in installed package for the selected build directory.
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, “configure build” for build sections.

Test_pack step

Usage: bv_maker [global options] test_pack [options]

Test in installed package for the selected build directory.
Options:
-h, --help show this help message and exit
--only-if-default
 only perform this step if it is a default step, or specified in the “default_steps” option of bv_maker.cfg config file. Default steps are normally “sources” for source sections, “configure build” for build sections.
-t CTEST_OPTIONS, --ctest_options=CTEST_OPTIONS
 options passed to ctest (ex: “-VV -R carto*”). Same as the configuration option ctest_options but specified at runtime. The commandline option here overrides the bv_maker.cfg options.