zephyr/scripts/schemas/arch-schema.yml
Benjamin Cabé a89c79275f scripts: hwm_v2: add full_name property for archs
Allow to specify a human readable full name for archs that can then be
leveraged e.g. in the documentation.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-06-06 10:29:44 +02:00

34 lines
958 B
YAML

# SPDX-License-Identifier: Apache-2.0
#
# Copyright (c) 2023, Nordic Semiconductor ASA
## A pykwalify schema for basic validation of the structure of a
## arch metadata YAML file.
##
# The archs.yml file is a simple list of key value pairs containing architectures
# and their location which is used by the build system.
type: map
mapping:
archs:
required: true
type: seq
sequence:
- type: map
mapping:
name:
required: true
type: str
desc: Name of the arch
path:
required: true
type: str
desc: Location of the arch implementation relative to the archs.yml file.
full_name:
required: false
type: str
desc: Full display name of the architecture
comment:
required: false
type: str
desc: Free form comment with extra information regarding the arch.