omni.repo.build.settings#

class omni.repo.build.settings.Settings#

Bases: object

Build Tool Settings

Parameters:

  • repo_folders (Dict) – Save repo_man.folders to ease passing around.

  • repo_folders_overwrite (Dict) – Overwrite certain repo folders.

  • custom_argument_parser (argparse.ArgumentParser) – Custom argparse.ArgumentParser instance user can optionally pass.

  • before_run_callback_fn (Callable) – Function to be called back before running anything.

  • partial_clean_folders (List[str]) – List of folders to clean during partial clean step.

  • stage_files_extra_mapping (Dict) – Add additional mappings to stage config (prebuild.toml)

  • stage_files_error_if_missing (bool) – Produce an error if one of staging entries missing.

  • stage_files_prebuild_files (List) – Override prebuild toml files to process.

  • vscode_python – Path to python to set into host-deps. By default use PM_python_DIR env var.

  • vscode_python_env (Dict) – Dict with env vars to write into python env files.

  • vscode_python_env_extra_mapping (Dict) – Add additional mappings to VSCode python env dict.

  • vscode_python_env_postprocess_fn (Callable) – Additional callback to be called which can postprocess VSCode python env dict.

  • generate_python_env_file (bool) – Do generate python_${config}.env files

  • generate_python_setup_shell_script (bool) – Do generate setup_python_${config}.bat/.sh

  • docker_image_url (str) – Docker image to use - override’s linbuild’s default image.

  • docker_extra_volumes (List[str]) – List of extra folders to pass to docker –with-volume.

  • sln_file (str) – Name of VS solution (for windows).

  • vs_version (str) – Visual Studio version: vs2017, vs2019, vs2022

  • link_host_toolchain (bool) – If True link to host Visual Studio and Windows SDK installations

  • vs_path (str) – Complete path to local Visual Studio installation

  • vs_edition (str) – Visual Studio edition: Community, Professional, Enterprise

  • msvc_version (str) – Microsoft Visual Build Tools version: 141, 142, 143

  • winsdk_path (str) – Complete path to local Windows SDK installation

  • winsdk_version (str) – Windows SDK version: 10.0.17763.0

  • prefer_devenv (bool) – Attempt to search for devenv installation and prefer it over MsBuild on windows. It seems to handle incremental build better.

  • extra_premake_args (List[str]) – Additional arguments to pass to premake.

  • build_error_processing (bool) – enable error context reporting at end of build stage.

  • build_error_patterns (List[str]) – regex strings to match against for error context.

  • build_error_context (List[int]) – regex match context lines to display.

  • ccache_settings (distributed_build.CCacheConfig) – A data type for configuring ccache

  • compiler (str) – Introduced to hold the clang compiler name

  • packman_extra_tokens (Dict) – A map of extra tokens used when fetching packman packages

  • verbose (bool) – Whether logging output should be verbose or not.

  • build_verbose (bool) – Whether compiler output should be verbose or not.

  • conan_enabled (bool) – If Conan is enabled for retrieving depenendencies.

  • pip_config (Dict) – A dictionary of options for controlling how to pull pip files.

  • msbuild_renice (bool) – If True try to wrangle msbuild compiler process priority.

  • metadata_file (str) – Path to write out some build metadata.

  • target_abi (str) – Target ABI version for build target.

On this page