[clang-tidy] Avoid recommending links to non-free coding guidelines

[jjmarr-amd]

Based on this thread, it might not be OK to link to MISRA/other coding guidelines that have tight restrictions on redistribution.

on-behalf-of: @amd JJ.Marr@amd.com

[github-actions]

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

[llvmbot]

@llvm/pr-subscribers-clang-tidy

@llvm/pr-subscribers-clang-tools-extra

Author: JJ Marr (jjmarr-amd)

Changes

Based on this thread, it might not be OK to link to MISRA/other non-free coding guidelines.

on-behalf-of: @amd <JJ.Marr@amd.com>

---

Full diff: https://github.com/llvm/llvm-project/pull/160745.diff

1 Files Affected:

• (modified) clang-tools-extra/docs/clang-tidy/Contributing.rst (+1-1)

diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index ad7f22381a3ca..c53fb32635629 100644
--- a/clang-tools-extra/docs/clang-tidy/Contributing.rst
+++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst
@@ -436,7 +436,7 @@ in the release notes, as the first sentence in the doxygen comments in the heade
 for your check class and as the first sentence of the check documentation.  Avoid the
 phrase "this check" in your check summary and check documentation.
 
-If your check relates to a published coding guideline (C++ Core Guidelines, MISRA, etc.)
+If your check relates to a freely licensed coding guideline (C++ Core Guidelines, etc.)
 or style guide, provide links to the relevant guideline or style guide sections in your
 check documentation.
 

[vbvictor]

LGTM

[HerrCai0907]

LGTM.
But I am wondering is it also prohibited to simply mention MISRA without mentioning the specific inspection content?

[carlosgalvezp]

I don't think simply mentioning MISRA is forbidden, there's mentions of it all over the place. But as it stands, the docs seem to suggest we support adding checks for MISRA and wants that we add links to the rules, which is not possible. So this patch is fine.

[carlosgalvezp]

We could also mention that we currently do not accept checks for MISRA/AUTOSAR due to legal/license reasons, and refer to the post on Discourse for more info.

[vbvictor]

We could also mention that we currently do not accept checks for MISRA/AUTOSAR due to legal/license reasons, and refer to the post on Discourse for more info.

But I guess we allow generic checks that "happen to be" Misra/autosar.
Like the recent avoid-default-lambda-capture. It's one of Misra guidelines but I didn't know that..

[carlosgalvezp]

But I guess we allow generic checks that "happen to be" Misra/autosar. Like the recent avoid-default-lambda-capture. It's one of Misra guidelines but I didn't know that..

Yep, I don't see any issue with that.

Worth noting is that checks may look the same as the MISRA/AUTOSAR rule but actually not check it exactly as it's formulated. Especially the latest MISRA C++:2023 guidelines have a very short rule headline, like "Avoid reinterpret_cast", but then in the expansion there's many exceptions to the rule, which e.g. cppcoreguidelines-pro-type-reinterpret-cast does not implement.

[github-actions]

@jjmarr-amd Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

[vbvictor]

Created a separate issue #160940 to track #160745 (comment)