kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-24 14:03:55 +01:00
Code Releases Activity
RIOT/dist/tools/features_yaml2mx/README.md
Marian Buschsieweke ce5bae3edb
dist/tools/features_yaml2mx: feature management utility 
Add a python script that allows having a single YAML file as source of
truth for what features are available, and also add documentation such
as help texts and grouping to them.

This utility converts such a YAML file to a Makefile with the contents

```
FEATURES_EXISTING := \
    feature_a \
    feature_b \
    ... \
    features_z \
    #
```

This allows the Makefile based build system to easily check if all
provided features and all requested features do actually exist.

In addition, this also converts the YAML file to a markdown file that
documents the features. This file is then intended to be used by
Doxygen to document the provided features.

Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de>
Co-authored-by: chrysn <chrysn@fsfe.org>
2024-02-23 15:12:07 +01:00

633 B
Raw Blame History

Tool to export features described in a YAML to formats usable by our build system

The python script in this folder converts features specified in a YAML file to a Makefile for use to check provided and requested features against, as well as a markdown file for consumption by Doxygen to document the features.

The YAML file containing the features is features.yaml in the root of the repo. Its syntax is documented in a comment on top of said file.

This script should be invoked by running make generate-features in the root of the repository.