[VPTOOL+Markdown] Improve configurability of DV plans.

Created by: zchamski

Overview

This PR adds extra flexibility in structuring DV plan database directories by allowing arbitrary directory structures and free-form strings in subsystem ("project") names.

It also adds support for preserving line breaks in free-form text fields of each verification item and introduces MD layout adjustments for improved readability.

Documentation

An introductory HOWTO document outlining the process of configuring verification plan databases and generating human-friendly output is located in file cva6/docs/VerifPlans/VPTOOL-VerifPlan-HOWTO.md.

Incompatible changes

Two new variables are needed in runme.sh scripts of individual DV plans:

• PROJECT_IDENT should contain an identifier-like string (no whitespace, no special characters) that will be used to construct the name of the output MD file
• MARKDOWN_OUTPUT_DIR shall point to a valid directory where the markdown output will be stored. The path can be arbitrary.

PROJECT_NAME can now be used to hold a free-form, human-friendly name of the project.

ChangeLog

• cva6/docs/VerifPlans/FRONTEND/VP_IP003.pck: Add blank lines in BTB item 002 to validate formatted MD output.
• cva6/docs/VerifPlans/FRONTEND/runme.sh (PROJECT_NAME): Update comment. (PROJECT_IDENT): New. (MARKDOWN_OUTPUT_DIR): Ditto.
• cva6/docs/VerifPlans/FRONTEND/vp_config.py (PROJECT_IDENT): New. (MARKDOWN_OUTPUT_DIR): Ditto. cva6/docs/VerifPlans/VPTOOL-VerifPlan-HOWTO.md: Ditto.
• cva6/docs/VerifPlans/source/dvplan_FRONTEND.md: Regenerate.
• tools/vptool/vptool/vp.py (MyMain.save_db): Use MARKDOWN_OUTPUT_DIR as destination of MD files instead of hardcoded path. Use PROJECT_IDENT to construct the MD file name. Change formatting of module heading.
• tools/vptool/vptool/vp_pack.py (Item.preserve_linebrs): New. (Item.__str__): Change formatting of heading. Preserve line breaks in free-form text fields. (Prop.__str__): Change formatting of heading. (Ip.__str__): Ditto.

Signed-off-by: Zbigniew Chamski zbigniew.chamski@thalesgroup.com