module documentation

Undocumented

Function apply_platform_specific_defaults Undocumented
Function build_catkin_package Undocumented
Function build_cmake_package Undocumented
Function build_package Undocumented
Function build_workspace_isolated Run cmake, make and optionally make install for all catkin packages in sourcespace_dir.
Function cmake_input_changed Undocumented
Function colorize_line Undocumented
Function cprint Undocumented
Function determine_path_argument Undocumented
Function extract_cmake_and_make_and_catkin_make_arguments Undocumented
Function extract_cmake_and_make_arguments Undocumented
Function extract_jobs_flags Undocumented
Function get_additional_environment Undocumented
Function get_multiarch Undocumented
Function get_new_env Undocumented
Function get_package_names_with_recursive_dependencies Undocumented
Function get_python_install_dir Undocumented
Function handle_make_arguments Undocumented
Function has_make_target Undocumented
Function isolation_print_command Undocumented
Function prefix_destdir Undocumented
Function print_command_banner Undocumented
Function run_command Undocumented
Function run_command_colorized Undocumented
Function split_arguments Undocumented
Function write_env_bat Undocumented
Function write_env_sh Undocumented
Function write_setup_bat Undocumented
Function write_setup_sh Undocumented
Variable blue_arrow Undocumented
Function _check_build_dir Undocumented
Function _extract_cmake_and_make_arguments Undocumented
Function _print_build_error Undocumented
def apply_platform_specific_defaults(args):

Undocumented

def build_catkin_package(path, package, workspace, buildspace, develspace, installspace, install, force_cmake, quiet, last_env, cmake_args, make_args, destdir=None, use_ninja=False, use_nmake=False, use_gmake=False):

Undocumented

def build_cmake_package(path, package, workspace, buildspace, develspace, installspace, install, force_cmake, quiet, last_env, cmake_args, make_args, destdir=None, use_ninja=False, use_nmake=False, use_gmake=False):

Undocumented

def build_package(path, package, workspace, buildspace, develspace, installspace, install, force_cmake, quiet, last_env, cmake_args, make_args, catkin_make_args, destdir=None, use_ninja=False, use_nmake=False, use_gmake=False, number=None, of=None):

Undocumented

def build_workspace_isolated(workspace='.', sourcespace=None, buildspace=None, develspace=None, installspace=None, merge=False, install=False, force_cmake=False, colorize=True, build_packages=None, ignore_packages=None, quiet=False, cmake_args=None, make_args=None, catkin_make_args=None, continue_from_pkg=False, only_pkg_with_deps=None, destdir=None, use_ninja=False, use_nmake=False, use_gmake=False, override_build_tool_check=False):

Run cmake, make and optionally make install for all catkin packages in sourcespace_dir.

It creates several folders in the current working directory. For non-catkin packages it runs cmake, make and make install for each, installing it to the devel space or install space if the install option is specified.

Parameters
workspacepath to the current workspace, str
sourcespaceworkspace folder containing catkin packages, str
buildspacepath to build space location, str
develspacepath to devel space location, str
installspacepath to install space (CMAKE_INSTALL_PREFIX), str
mergeif True, build each catkin package into the same devel space (not affecting plain cmake packages), bool
installif True, install all packages to the install space, bool
force_cmake(optional), if True calls cmake explicitly for each package, bool
colorizeif True, colorize cmake output and other messages, bool
build_packagesspecific packages to build (all parent packages in the topological order must have been built before), str
ignore_packagesUndocumented
quietif True, hides some build output, bool
cmake_argsadditional arguments for cmake, [str]
make_argsadditional arguments for make, [str]
catkin_make_argsadditional arguments for make but only for catkin packages, [str]
continue_from_pkgindicates whether or not cmi should continue when a package is reached, bool
only_pkg_with_depsonly consider the specific packages and their recursive dependencies and ignore all other packages in the workspace, [str]
destdirdefine DESTDIR for cmake/invocation, string
use_ninjaif True, use ninja instead of make, bool
use_nmakeif True, use nmake instead of make, bool
use_gmakeif True, use gmake instead of make, bool
override_build_tool_checkif True, build even if a space was built by another tool previously.
def cmake_input_changed(packages, build_path, cmake_args=None, filename='catkin_make'):

Undocumented

def colorize_line(line):

Undocumented

def cprint(msg, end=None):

Undocumented

def determine_path_argument(cwd, base_path, argument, default):

Undocumented

def extract_cmake_and_make_and_catkin_make_arguments(args):

Undocumented

def extract_cmake_and_make_arguments(args):

Undocumented

def extract_jobs_flags(mflags):

Undocumented

def get_additional_environment(install, destdir, installspace):

Undocumented

def get_multiarch():

Undocumented

def get_new_env(package, develspace, installspace, install, last_env, destdir=None):

Undocumented

def get_package_names_with_recursive_dependencies(packages, pkg_names):

Undocumented

def get_python_install_dir():

Undocumented

def handle_make_arguments(input_make_args, append_default_jobs_flags=True):

Undocumented

def has_make_target(path, target, use_ninja=False, use_nmake=False, use_gmake=False):

Undocumented

def isolation_print_command(cmd, path=None, add_env=None):

Undocumented

def prefix_destdir(path, destdir=None):

Undocumented

def print_command_banner(cmd, cwd, color):

Undocumented

def run_command(cmd, cwd, quiet=False, colorize=False, add_env=None):

Undocumented

def run_command_colorized(cmd, cwd, quiet=False, add_env=None):

Undocumented

def split_arguments(args, splitter_name, default=None):

Undocumented

def write_env_bat(dest_file, variables):

Undocumented

def write_env_sh(dest_file, variables):

Undocumented

def write_setup_bat(dest_file, last_setup_basename, variables):

Undocumented

def write_setup_sh(dest_file, last_setup_basename, variables):

Undocumented

blue_arrow: str =

Undocumented

def _check_build_dir(name, workspace, buildspace):

Undocumented

def _extract_cmake_and_make_arguments(args, extract_catkin_make):

Undocumented

def _print_build_error(package, e):

Undocumented