Skip to content

5 REQ ref_req

Jump to bottom
Manuel Hatzl edited this page Sep 28, 2023 · 7 revisions

ref_req: Reference requirements

References:

  • in branch main: 6 (4 direct)

It must be possible to reference requirements using their IDs. Otherwise, semi-automatic tracing is not possible, because mantra cannot determine if a requirement is active or not.

The syntax to reference requirements is: [req:req_id]

Note: req_id is used as placeholder, and must be replaced by an existing ID.

Created in response to issue #1.

Implementation details

This syntax was chosen, because it should be independent enough in most programming languages that regex can be used to search for references, while still being able to distinguish an expression from a requirement reference.

Using regex simplifies the implementation effort, because textual files may be searched without the need to first analyze the semantics of a programming language.

Sub-requirements

ref_req.test: Test requirement referencing

References:

  • in branch main: 1

Add a test to make sure that references are found in some content.

Please create an issue if you found any spelling mistakes.
You may also create an issue if you think the content of this wiki should be improved.

Note: This wiki is managed in its own repository. Any commits made using the edit button will be overwritten.

Note: Issues for the wiki are handled in the mantra repository, but pull requests for the wiki are handled in the mantra-wiki repository.

This wiki is MIT licensed, and works together with mantra.

{{

Sidebar that is displayed on every wiki page.

}}

REQ-Referencing Overview:

Last update: 2023-09-28_14:02 UTC
Repository: mhatzl/mantra
Branch: main
Commit: 82d26a6

Clone this wiki locally