Features

🔍 Features

ID

Title

SI

Errors

FE_UBC_BUILD_JSON

Build needs.json

yes

ER_UBC_JSON_INCOMPLETE

FE_UBC_CACHE

Clean internal caches

no

FE_UBC_FORMAT

Format rst files

yes

ER_UBC_FORMAT_ERRORS

FE_UBC_LINTING

Check rst files for linting problems

no

ER_UBC_LINTING_NOT_COVERED

FE_UBC_VALIDATE_JSON

Validate needs.json

no

ER_UBC_VAL_FORMAT; ER_UBC_VAL_INCOMPLETE

../../_images/need_pie_b9aa3.svg
Feature: Check rst files for linting problems FE_UBC_LINTING
style: green_bar
si: no
td: 1
Error: Not covered format ER_UBC_LINTING_NOT_COVERED
style: red_bar
td: 1
parent needs: FE_UBC_LINTING
Feature: Format rst files FE_UBC_FORMAT
style: green_bar
si: yes
td: 1
tools: TOOL_UBC
Error: Format introduces errors ER_UBC_FORMAT_ERRORS
style: red_bar
td: 1
parent needs: FE_UBC_FORMAT
Feature: Clean internal caches FE_UBC_CACHE
style: green_bar
si: no
td: 1
tools: TOOL_UBC
Feature: Build needs.json FE_UBC_BUILD_JSON
style: green_bar
si: yes
td: 3
Error: Incomplete data ER_UBC_JSON_INCOMPLETE
style: red_bar
td: 3

This can have several reasons:

  • Not supported or unknown Sphinx-Needs directives. Like

    • list2needs

  • Not supported features of Sphinx-Needs. Like

    • dynamic functions

  • Unknown script executions

  • Unknown/not accessible sources, like

    • external services

    • import of needs.json files

    • unknown rst files

Feature: Validate needs.json FE_UBC_VALIDATE_JSON
style: green_bar
si: no
td: 1
Error: Unknown file format ER_UBC_VAL_FORMAT
style: red_bar
td: 1
parent needs: FE_UBC_VALIDATE_JSON
Error: Incomplete Validation ER_UBC_VAL_INCOMPLETE
style: red_bar
td: 1
parent needs: FE_UBC_VALIDATE_JSON

Not all types and options, which are represetned in a given needs.json file, are known/defined by the ubproject.toml configuration.