Spaces Documentation
Sdk
Cmake

cmake_add_configure_build_install() 

def cmake_add_configure_build_install(name, source_directory, build_directory, prefix_paths, configure_inputs, build_inputs, configure_args, build_args, build_artifact_globs, deps, install_path, skip_install)

Add a CMake project to the build

Args

  • name - The name of the project
  • source_directory - The directory of the project
  • build_directory - The directory to build the project in (default is build/)
  • prefix_paths - The paths to add to the CMAKE_PREFIX_PATH: default is sysroot;build/install (uses absolute paths)
  • configure_inputs - The inputs for the configure step. Default uses cmake files in source directory
  • build_inputs - The inputs for the build step. Default uses source directory
  • configure_args - The arguments to pass to the configure script
  • build_args - The arguments to pass to the build command
  • build_artifact_globs - The globs to match when installing build artifacts
  • deps - The dependencies of the project
  • install_path - The path to install the project
  • skip_install - Skip the install step

cmake_add_repo() 

def cmake_add_repo(name, url, rev, install_path, configure_args, build_args, build_artifact_globs, checkout_submodules, relative_source_directory, clone, checkout_type, skip_install, deps)

Add a CMake project to the build

Args

  • name - The name of the project
  • url - The URL of the repository
  • rev - The revision of the repository
  • install_path - The path to install the project
  • configure_args - The arguments to pass to the configure script
  • build_args - The arguments to pass to the build command
  • build_artifact_globs - The globs to match when installing build artifacts
  • checkout_submodules - Whether to checkout submodules
  • relative_source_directory - The directory of the project (default is the name)
  • clone - The clone type (Worktree, Blobless, Shallow, Default)
  • checkout_type - str use checkout_type_optional() to skip rule checkout
  • skip_install - Skip the install step
  • deps - The dependencies of the project

cmake_add_source_archive() 

def cmake_add_source_archive(name, url, sha256, source_directory, filename, install_path, configure_args, build_args, build_artifact_globs, deps, checkout_type, skip_install)

Add a CMake project to the build

Args

  • name - str The name of the project
  • url - str The URL of the source archive
  • sha256 - str The SHA256 of the source archive
  • source_directory - str The directory of the project
  • filename - str The filename of the source archive
  • install_path - str The path to install the project
  • configure_args - [str] The arguments to pass to the configure script
  • build_args - [str] The arguments to pass to the build command
  • build_artifact_globs - [str] The globs to match when installing build artifacts
  • deps - [str] List of dependencies of the project
  • checkout_type - str use checkout_type_optional() to skip rule checkout
  • skip_install - Skip the install step

cmake_get_default_prefix_paths() 

def cmake_get_default_prefix_paths(install_path)

Get the default prefix paths for CMake

Args

  • install_path - The path to install the project

Returns

A list of the default prefix paths

CheckoutGh