From a444547adeb5b15b513513d3fd0446619f5058a0 Mon Sep 17 00:00:00 2001 From: "Kostadin Ivanov (BD/TBC-BG)" <kostadin.ivanov@bosch.com> Date: Wed, 4 Dec 2024 11:55:21 +0200 Subject: [PATCH] Add entry for samm exporter in the vspec docs - help example. Signed-off-by: Kostadin Ivanov (BD/TBC-BG) <kostadin.ivanov@bosch.com> --- docs/vspec.md | 35 ++++++++++++------------ src/vss_tools/exporters/samm/__init__.py | 2 +- 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/vspec.md b/docs/vspec.md index de88138c..20591f0e 100644 --- a/docs/vspec.md +++ b/docs/vspec.md @@ -8,23 +8,24 @@ For the most up do date usage information, please call the tool help via: vspec export --help Usage: vspec export [OPTIONS] COMMAND [ARGS]... -╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────╮ -│ apigear Export to ApiGear. │ -│ binary Export to Binary. │ -│ csv Export as CSV. │ -│ ddsidl Export as DDSIDL. │ -│ franca Export as Franca. │ -│ graphql Export as GraphQL. │ -│ id Export as IDs. │ -│ json Export as JSON. │ -│ jsonschema Export as a jsonschema. │ -│ protobuf Export as protobuf. │ -│ yaml Export as YAML. │ -│ tree Export as Tree. │ -╰────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ --help Show this message and exit. │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ apigear Export to ApiGear. │ +│ binary Export to Binary. │ +│ csv Export as CSV. │ +│ ddsidl Export as DDSIDL. │ +│ franca Export as Franca. │ +│ graphql Export as GraphQL. │ +│ id Export as IDs. │ +│ json Export as JSON. │ +│ jsonschema Export as a jsonschema. │ +│ protobuf Export as protobuf. │ +| samm Export as Eclipse Semantic Modeling Framework (ESMF) - Semantic Aspect Meta Model (SAMM) - .ttl files. | +│ yaml Export as YAML. │ +│ tree Export as Tree. │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ ``` diff --git a/src/vss_tools/exporters/samm/__init__.py b/src/vss_tools/exporters/samm/__init__.py index bdd0c4f4..0dce88be 100644 --- a/src/vss_tools/exporters/samm/__init__.py +++ b/src/vss_tools/exporters/samm/__init__.py @@ -176,7 +176,7 @@ def cli( split_depth, ) -> None: """ - Export COVESA VSS to Eclipse Semantic Modeling Framework (ESMF) - Semantic Aspect Meta Model (SAMM) - .ttl files. + Export as Eclipse Semantic Modeling Framework (ESMF) - Semantic Aspect Meta Model (SAMM) - .ttl files. """ log.info("Loading VSS Tree...\n")