[clang-tools-extra] [clang-tidy] Avoid recommending links to non-free coding guidelines (PR #160745)

JJ Marr via cfe-commits cfe-commits at lists.llvm.org
Thu Sep 25 12:10:16 PDT 2025


https://github.com/jjmarr-amd updated https://github.com/llvm/llvm-project/pull/160745

>From fb93cd8ea5476098ac3d9780c7724ede69cfd57a Mon Sep 17 00:00:00 2001
From: jjmarr-amd <JJ.Marr at amd.com>
Date: Thu, 25 Sep 2025 13:28:08 -0400
Subject: [PATCH 1/2] Clarify footgun

on-behalf-of: @amd <JJ.Marr at amd.com>
---
 clang-tools-extra/docs/clang-tidy/Contributing.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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.
 

>From 3387588baa9de45e0270188ca323c0d15de2e356 Mon Sep 17 00:00:00 2001
From: jjmarr-amd <JJ.Marr at amd.com>
Date: Thu, 25 Sep 2025 15:10:02 -0400
Subject: [PATCH 2/2] more accurate

on-behalf-of: @amd <JJ.Marr at amd.com>
---
 clang-tools-extra/docs/clang-tidy/Contributing.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst
index c53fb32635629..4ede4ea36c13d 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 freely licensed coding guideline (C++ Core Guidelines, etc.)
+If your check relates to a published coding guideline (C++ Core Guidelines, SEI CERT, etc.)
 or style guide, provide links to the relevant guideline or style guide sections in your
 check documentation.
 



More information about the cfe-commits mailing list