cbuild

module
v2.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 4, 2024 License: Apache-2.0

README

Release Build Test TPIP Check Markdown

Maintainability Test Coverage OpenSSF Scorecard

cbuild: Open-CMSIS-Pack Build Invocation Utility

This utility allows embedded developers to build CPRJ and csolution projects by orchestrating the following tools:

  • cbuildgen
  • csolution
  • cpackget
  • cmake
  • ninja

By default, cbuild expects a fully configured solution (.csolution.yml) or context (.cprj). As such, it will not create, copy or update any files in the RTE directories. In case such modifications are required, use the command line option: --update-rte.

Usage

cbuild: Build Invocation 2.0.0 (C) 2024 Arm Ltd. and Contributors

Usage:
  cbuild [command] <name>.csolution.yml [options]

Commands:
  buildcprj   Use a *.CPRJ file as build input
  help        Help about any command
  list        List information about environment, toolchains, and contexts

Options:
  -C, --clean              Remove intermediate and output directories
  -c, --context arg [...]  Input context names [<project-name>][.<build-type>][+<target-type>]
  -S, --context-set        Use context set
  -d, --debug              Enable debug messages
      --frozen-packs       The list of packs from cbuild-pack.yml is frozen and raises error if not up-to-date
  -g, --generator arg      Select build system generator (default "Ninja")
  -h, --help               Print usage
  -j, --jobs int           Number of job slots for parallel execution
  -l, --load arg           Set policy for packs loading [latest | all | required]
      --log arg            Save output messages in a log file
  -O, --output arg         Set directory for all output files
  -p, --packs              Download missing software packs with cpackget
  -q, --quiet              Suppress output messages except build invocations
  -r, --rebuild            Remove intermediate and output directories and rebuild
  -s, --schema             Validate project input file(s) against schema
  -t, --target arg         Optional CMake target name
      --toolchain arg      Input toolchain to be used
      --update-rte         Update the RTE directory and files
  -v, --verbose            Enable verbose messages from toolchain builds
  -V, --version            Print version

Use "cbuild [command] --help" for more information about a command.

Directories

Path Synopsis
cmd
cbuild/commands/build
* Copyright (c) 2023 Arm Limited.
* Copyright (c) 2023 Arm Limited.
cbuild/commands/list
* Copyright (c) 2023 Arm Limited.
* Copyright (c) 2023 Arm Limited.
cbuild/commands/setup
* Copyright (c) 2024 Arm Limited.
* Copyright (c) 2024 Arm Limited.
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL