impl: proposal for coding guidelines #647

hoe-jo · 2025-03-12T10:32:39Z

Coding Guidelines
Code Analysis

- Coding Guidelines - Code Analysis - MISRA mapping

github-actions · 2025-03-12T10:33:40Z

License Check Results

🚀 The license check preparation job ran successfully.

Status: ⚠️ Needs Review

Click to expand output

2025/03/12 10:32:55 Downloading https://releases.bazel.build/7.4.0/release/bazel-7.4.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)

Analyzing: target //docs:license.check.python (90 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (91 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (97 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (126 packages loaded, 794 targets configured)

Analyzing: target //docs:license.check.python (131 packages loaded, 1620 targets configured)

Analyzing: target //docs:license.check.python (139 packages loaded, 2430 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (147 packages loaded, 4487 targets configured)

INFO: Analyzed target //docs:license.check.python (149 packages loaded, 4736 targets configured).
[9 / 13] JavaToolchainCompileClasses external/rules_java~/toolchains/platformclasspath_classes; 0s processwrapper-sandbox ... (2 actions running)
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java~/toolchains/platformclasspath.jar; 0s processwrapper-sandbox
INFO: Found 1 target...
Target //docs:license.check.python up-to-date:
  bazel-bin/docs/license.check.python
  bazel-bin/docs/license.check.python.jar
INFO: Elapsed time: 23.469s, Critical Path: 2.44s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/docs/license.check.python docs/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/score -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 69 items.
[main] INFO Found 45 items.
[main] INFO Querying ClearlyDefined for license data for 31 items.
[main] INFO Found 31 items.
[main] INFO License information could not be automatically verified for the following content:
[main] INFO 
[main] INFO pypi/pypi/-/debugpy/1.8.12
[main] INFO pypi/pypi/-/docutils/0.21.2
[main] INFO pypi/pypi/-/fonttools/4.56.0
[main] INFO pypi/pypi/-/matplotlib/3.10.0
[main] INFO pypi/pypi/-/numpy/2.2.3
[main] INFO pypi/pypi/-/pillow/11.1.0
[main] INFO pypi/pypi/-/pyparsing/3.2.1
[main] INFO 
[main] INFO This content is either not correctly mapped by the system, or requires review.
[main] INFO A review is required for pypi/pypi/-/numpy/2.2.3.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19888 .
[main] INFO A review is required for pypi/pypi/-/fonttools/4.56.0.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19889 .
[main] INFO A review is required for pypi/pypi/-/docutils/0.21.2.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19880 .
[main] INFO A review is required for pypi/pypi/-/pillow/11.1.0.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19890 .
[main] INFO A review is required for pypi/pypi/-/pyparsing/3.2.1.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19891 .
[main] INFO A review is required for pypi/pypi/-/debugpy/1.8.12.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19903 .
[main] INFO A review is required for pypi/pypi/-/matplotlib/3.10.0.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19892 .

github-actions · 2025-03-12T10:36:01Z

The created documentation from the pull request is available at: docu-html

dcalavrezo-qorix · 2025-03-12T15:58:39Z

docs/process/process_areas/implementation/guidance/cpp/code_analysis.rst

+Coverage
+========
+
+As required by the verification guideline coverage needs to be calculated for the code which is used in the project. For a release the coverage needs to be calculated on the target (QNX). However for development also a quicker approach on the host shall be available.


I don't understand why QNX is mentioned in here.

QNX is not target meant in ISO26262, we need here reference HW coverage

dcalavrezo-qorix · 2025-03-12T16:04:24Z

docs/process/process_areas/implementation/guidance/cpp/code_analysis.rst

+
+Following sections provide a short overview of the most important features of each applied tool:
+
+Memcheck


back in the day I was using Valgrind - of which Memcheck is part of. It supports additional tools for dynamic checks.

dcalavrezo-qorix · 2025-03-12T16:05:35Z

docs/process/process_areas/implementation/guidance/cpp/misra_2023_rule_mapping.rst

+..
+    .. csv-table:: MISRA C++:2023 Rule Mapping
+    :name: misra_2023_rule_mapping
+    :file: _assets/misra_2023.csv


is the file missing, I saw that you added *csv in the docs/BUILD?

Maybe you forgot to stash it?

masc2023 · 2025-03-12T16:07:56Z

docs/process/process_areas/implementation/guidance/cpp/coding_guidelines.rst

+
+Code Formatter
+==============
+Appropriate code formatting provides a source code which is easier to read and better to understand as it follows a well defined, known standard. That is why usually code formatters are applied. For this project *Clang-Format* shall be used.


shall be used is normative formulation, would expect that either as process requirement or in another decision document, there are more shalls in this document

masc2023

For showing in the audit, it is ok for me, but I would this document in the future not under process

masc2023 · 2025-03-12T16:24:03Z

docs/process/process_areas/implementation/guidance/cpp/code_analysis.rst

+   coverage --> gtest
+   gtest --> gcov
+   gcov --> host
+   gcov --> qnx


qnx -> reference HW

impl: proposal for coding guidelines

46123fa

- Coding Guidelines - Code Analysis - MISRA mapping

hoe-jo requested review from dcalavrezo-qorix, masc2023 and AlexanderLanin March 12, 2025 15:51

dcalavrezo-qorix reviewed Mar 12, 2025

View reviewed changes

masc2023 reviewed Mar 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

impl: proposal for coding guidelines #647

impl: proposal for coding guidelines #647

hoe-jo commented Mar 12, 2025

github-actions bot commented Mar 12, 2025

github-actions bot commented Mar 12, 2025

dcalavrezo-qorix Mar 12, 2025

masc2023 Mar 12, 2025

dcalavrezo-qorix Mar 12, 2025

dcalavrezo-qorix Mar 12, 2025 •

edited

Loading

masc2023 Mar 12, 2025

masc2023 left a comment

masc2023 Mar 12, 2025


		Following sections provide a short overview of the most important features of each applied tool:

		Memcheck

impl: proposal for coding guidelines #647

Are you sure you want to change the base?

impl: proposal for coding guidelines #647

Conversation

hoe-jo commented Mar 12, 2025

github-actions bot commented Mar 12, 2025

License Check Results

github-actions bot commented Mar 12, 2025

dcalavrezo-qorix Mar 12, 2025

Choose a reason for hiding this comment

masc2023 Mar 12, 2025

Choose a reason for hiding this comment

dcalavrezo-qorix Mar 12, 2025

Choose a reason for hiding this comment

dcalavrezo-qorix Mar 12, 2025 • edited Loading

Choose a reason for hiding this comment

masc2023 Mar 12, 2025

Choose a reason for hiding this comment

masc2023 left a comment

Choose a reason for hiding this comment

masc2023 Mar 12, 2025

Choose a reason for hiding this comment

dcalavrezo-qorix Mar 12, 2025 •

edited

Loading