Skip to content

Commit 79d1535

Browse files
committed
[#493] Add C++ functional safety link into main README.md
1 parent 1eefa82 commit 79d1535

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ More documentation? Go to the [Documentation](#documentation).
3939

4040
At the moment the following code generators are available
4141
- [C++ Generator](compiler/extensions/cpp/README.md) with [C++ Runtime Library](https://zserio.org/doc/runtime/latest/cpp)
42+
supporting [functional safety](compiler/extensions/cpp/README.md#functional-safety-features)
4243
- [Java Generator](compiler/extensions/java/README.md) with [Java Runtime Library](https://zserio.org/doc/runtime/latest/java)
4344
- [Python Generator](compiler/extensions/python/README.md) with [Python Runtime Library](https://zserio.org/doc/runtime/latest/python)
4445

compiler/extensions/cpp/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ The following describes features which minimize the risk of Zserio C++ runtime l
2626
Clang-tidy tool is run using [this configuration](https://github.com/ndsev/zserio/blob/master/compiler/extensions/cpp/runtime/ClangTidyConfig.txt).
2727
The clang-tidy report from the latest C++ runtime library is available [here](https://zserio.org/doc/runtime/latest/cpp/clang-tidy/clang-tidy-report.txt).
2828

29-
Because C++ runtime library is very low level (e.g. it mimic `std::span` or `std::string_view` standard
29+
Because C++ runtime library is very low level (e.g. it mimics `std::span` or `std::string_view` standard
3030
abstraction from C++17), it was not possible to fix all clang-tidy findings.
3131

3232
Therefore all clang-tidy findings have been carefully checked and filtered out using definitions in clang-tidy
3333
[suppression file](https://github.com/ndsev/zserio/blob/master/compiler/extensions/cpp/runtime/ClangTidySuppressions.txt).
34-
This suppression file contains as well the brief reasoning why these findings cannot be fixed. This solution
34+
This suppression file contains as well the brief reasoning why these findings were not fixed. This solution
3535
with suppression file has been chosen not to pollute C++ runtime sources with `// NOLINT` comments and to
3636
allow implementation of warnings-as-error feature. The clang-tidy suppression file is automatically used
3737
during compilation using `CMake`.

0 commit comments

Comments
 (0)