README.md

LOBSTER

The Lightweight Open BMW Software Traceability Evidence Report allows you to demonstrate software traceability and requirements coverage, which is essential for meeting standards such as ISO 26262.

This package contains a tool extract tracing tags from ISO C or C++ source code. This tool is making use of a clang-tidy hack, and for this to work you need to build our clang-tidy fork and place the clang-tidy binary somewhere on your PATH.

This tool works using a custom clang-tidy checker lobster-trace which emits tracing information as clang checks.

We plan to rework this tool to be a stand-alone clang tool in the future.

Tools

• lobster-cpp: Extract requirements from C/C++ code using a clang-tidy hack

Usage

This tool supports C/C++ code.

For this you can embedd tracing tags like this:

#include <string>
class Potato {
public:
    std::string potato() {
        // lobster-trace: something.example
        return "potato";
    }
};

You can add justifications as well:

#include <string>
class Potato {
public:
    std::string potato() {
        // lobster-exclude: Reason to justify the exlude
        return "potato";
    }
};

Copyright & License information

The copyright holder of LOBSTER is the Bayerische Motoren Werke Aktiengesellschaft (BMW AG), and LOBSTER is published under the GNU Affero General Public License, Version 3.