From 6a3064fdf6883fa09b4325e6f011f0e8acad295e Mon Sep 17 00:00:00 2001 From: Ole Troan Date: Tue, 14 May 2019 13:24:10 +0200 Subject: tools: FEATURE.yaml meta-data infrastructure Add tooling for feature metadata configuration files. The main tool is in src/scripts/fts.py make checkfeaturelist to validate against schema. make featurelist to dump all feature lists to stdout. Example feature definition: name: IP in IP tunnelling maintainer: Ole Troan features: - IPv4/IPv6 over IPv4/IPv6 encapsulation: - Fragmentation and Reassembly - Configurable MTU - Inner to outer Traffic Class / TOS copy - Configurable Traffic Class / TOS - ICMPv4 / ICMPv6 proxying - 6RD (RFC5969): - Border Relay description: "Implements IP{v4,v6} over IP{v4,v6} tunnelling as described in RFC2473. This module also implement the border relay of 6RD (RFC5969)." state: production properties: [API, CLI, STATS, MULTITHREAD] missing: - Tunnel PMTUD - Tracking of FIB state for tunnel state - IPv6 extension headers (Tunnel encapsulation limit option) JSON schema is embedded in fts.py Example markdown: https://github.com/otroan/scratch/blob/master/features.md Change-Id: I903b4ee6b316a9378c259e86dc937092e5d4b7da Type: make Signed-off-by: Ole Troan --- Makefile | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 90ed59f11c0..7f3c4295e88 100644 --- a/Makefile +++ b/Makefile @@ -67,7 +67,7 @@ DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev DEB_DEPENDS += python-all python3-all python3-setuptools python-dev DEB_DEPENDS += python-virtualenv python-pip libffi6 check DEB_DEPENDS += libboost-all-dev libffi-dev python3-ply libmbedtls-dev -DEB_DEPENDS += cmake ninja-build uuid-dev +DEB_DEPENDS += cmake ninja-build uuid-dev python3-jsonschema ifeq ($(OS_VERSION_ID),14.04) DEB_DEPENDS += libssl-dev else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8) @@ -94,7 +94,7 @@ ifeq ($(OS_ID),fedora) RPM_DEPENDS += subunit subunit-devel RPM_DEPENDS += compat-openssl10-devel RPM_DEPENDS += python3-devel python3-ply - RPM_DEPENDS += python3-virtualenv + RPM_DEPENDS += python3-virtualenv python3-jsonschema RPM_DEPENDS += cmake RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries' else @@ -102,7 +102,7 @@ else RPM_DEPENDS += openssl-devel RPM_DEPENDS += python-devel python36-ply RPM_DEPENDS += python36-devel python36-pip - RPM_DEPENDS += python-virtualenv + RPM_DEPENDS += python-virtualenv python36-jsonschema RPM_DEPENDS += devtoolset-7 RPM_DEPENDS += cmake3 RPM_DEPENDS_GROUPS = 'Development Tools' @@ -216,6 +216,8 @@ help: @echo " doxygen - (re)generate documentation" @echo " bootstrap-doxygen - setup Doxygen dependencies" @echo " wipe-doxygen - wipe all generated documentation" + @echo " checkfeaturelist - check FEATURE.yaml according to schema" + @echo " featurelist - dump feature list in markdown" @echo " docs - Build the Sphinx documentation" @echo " docs-venv - Build the virtual environment for the Sphinx docs" @echo " docs-clean - Remove the generated files from the Sphinx docs" @@ -544,6 +546,12 @@ checkstyle: fixstyle: @build-root/scripts/checkstyle.sh --fix +featurelist: + @build-root/scripts/fts.py --all --markdown + +checkfeaturelist: + @build-root/scripts/fts.py --validate --git-status + # # Build the documentation # -- cgit 1.2.3-korg