Skip to content

Fprime util

Note: auto-generated from comments in: ./fprime-util.cmake

fprime-util.cmake:

This file contains utility functions for writing the metadata used by fprime-util for supporting the standard fprime development process.

Function fprime_util_metadata_clear:

Clears all metadata files written to a subdirectory. This is expected to be called when the subdirectory is added and removes all files written to this directory.

Parameters: - CHILD_DIRECTORY: directory to clear metadata from

Function fprime_util_metadata_add_subdirectory:

This adds a new subdirectory from a metadata perspective by performing several steps: 1. Clears the metadata for the subdirectory 2. Adds the subdirectory to the current directory's subdirectory list

Parameters: - CHILD_SOURCE_DIRECTORY: source directory of the subdirectory - CHILD_BINARY_DIRECTORY: binary directory of the subdirectory

Function fprime_util_metadata_add_build_target:

This adds a new build target from a metadata perspective by adding it to the list in the current directory.

Parameters: - BUILD_TARGET: name of the build target to add

Function fprime_util_metadata_add_test:

This adds a new test from a metadata perspective by adding it to the list in the current directory.

Parameters: - TEST_NAME: name of the test to add

Function fprime_util_metadata_set_test_dir:

Sets the CTest test directory for the current build directory. This writes a test-dir.fprime-util file that tells fprime-util where CTest should look for registered tests. Used when the test enumeration directory differs from the CTest test directory (e.g. deployment tests that aggregate component tests from sibling directories).

Parameters: - TEST_DIR: absolute path to use as the CTest --test-dir