[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
https://github.com/steakhal closed https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
@@ -1,10 +1,10 @@ -//===- unittest/ASTMatchers/Dynamic/VariantValueTest.cpp - VariantValue unit tests -===// +// unittest/ASTMatchers/Dynamic/VariantValueTest.cpp - VariantValue unit tests steakhal wrote: Fixed. https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
https://github.com/steakhal updated https://github.com/llvm/llvm-project/pull/82919 >From 319329630e0d2a86b22dd435985026ea236f8e56 Mon Sep 17 00:00:00 2001 From: Balazs Benics Date: Sun, 25 Feb 2024 12:48:06 +0100 Subject: [PATCH 1/2] [clang][NFC] Trim license header comments to 81 characters clang-format would format these headers poorly by splitting it into multiple lines. ```regex //=.{78,} ``` --- clang/include/clang/AST/DeclOpenMP.h | 2 +- clang/include/clang/AST/ParentMapContext.h| 2 +- clang/include/clang/Basic/OpenCLExtensionTypes.def| 2 +- clang/include/clang/Basic/RISCVVTypes.def | 8 clang/include/clang/Basic/arm_neon_incl.td| 2 +- .../include/clang/Serialization/PCHContainerOperations.h | 2 +- .../clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h | 2 +- clang/lib/ARCMigrate/TransGCAttrs.cpp | 2 +- clang/lib/AST/Interp/ByteCodeEmitter.h| 2 +- clang/lib/AST/Interp/FunctionPointer.h| 2 +- clang/lib/AST/Interp/PrimType.h | 2 +- clang/lib/Driver/ToolChains/Arch/Mips.h | 2 +- clang/lib/Driver/ToolChains/Arch/Sparc.h | 2 +- clang/lib/Headers/llvm_libc_wrappers/assert.h | 2 +- clang/lib/Sema/AnalysisBasedWarnings.cpp | 2 +- clang/lib/Sema/SemaChecking.cpp | 2 +- .../lib/StaticAnalyzer/Checkers/DirectIvarAssignment.cpp | 2 +- .../Checkers/ObjCAutoreleaseWriteChecker.cpp | 2 +- .../lib/StaticAnalyzer/Checkers/STLAlgorithmModeling.cpp | 2 +- clang/lib/StaticAnalyzer/Checkers/SimpleStreamChecker.cpp | 2 +- clang/lib/StaticAnalyzer/Core/RangeConstraintManager.cpp | 2 +- clang/lib/Tooling/Refactoring/AtomicChange.cpp| 2 +- clang/test/Analysis/misc-ps-region-store.mm | 4 ++-- clang/test/Rewriter/rewrite-modern-class.mm | 2 +- .../tools/clang-fuzzer/proto-to-llvm/loop_proto_to_llvm.h | 2 +- clang/tools/diagtool/DiagTool.cpp | 2 +- clang/unittests/AST/ASTImporterODRStrategiesTest.cpp | 2 +- clang/unittests/ASTMatchers/Dynamic/RegistryTest.cpp | 4 ++-- clang/unittests/ASTMatchers/Dynamic/VariantValueTest.cpp | 4 ++-- .../CXXOperatorCallExprTraverser.cpp | 2 +- .../RecursiveASTVisitorTests/CallbacksBinaryOperator.cpp | 4 ++-- .../CallbacksCompoundAssignOperator.cpp | 2 +- .../RecursiveASTVisitorTests/CallbacksUnaryOperator.cpp | 4 ++-- .../InitListExprPostOrderNoQueue.cpp | 2 +- .../InitListExprPreOrderNoQueue.cpp | 2 +- .../TemplateArgumentLocTraverser.cpp | 2 +- 36 files changed, 44 insertions(+), 44 deletions(-) diff --git a/clang/include/clang/AST/DeclOpenMP.h b/clang/include/clang/AST/DeclOpenMP.h index 73725e6e85666a..8fdfddb6c1fd74 100644 --- a/clang/include/clang/AST/DeclOpenMP.h +++ b/clang/include/clang/AST/DeclOpenMP.h @@ -1,4 +1,4 @@ -//===- DeclOpenMP.h - Classes for representing OpenMP directives -*- C++ -*-===// +//===- DeclOpenMP.h - Classes for representing OpenMP directives -*- C++ -*-==// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/AST/ParentMapContext.h b/clang/include/clang/AST/ParentMapContext.h index d3b2e3986a9935..6f79038627d9e1 100644 --- a/clang/include/clang/AST/ParentMapContext.h +++ b/clang/include/clang/AST/ParentMapContext.h @@ -1,4 +1,4 @@ -//===- ParentMapContext.h - Map of parents using DynTypedNode ---*- C++ -*-===// +//===- ParentMapContext.h - Map of parents using DynTypedNode ---*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/Basic/OpenCLExtensionTypes.def b/clang/include/clang/Basic/OpenCLExtensionTypes.def index 17c72d69a02065..50ea826c18a77c 100644 --- a/clang/include/clang/Basic/OpenCLExtensionTypes.def +++ b/clang/include/clang/Basic/OpenCLExtensionTypes.def @@ -1,4 +1,4 @@ -//===-- OpenCLExtensionTypes.def - Metadata about BuiltinTypes --*- C++ -*-===// +//===-- OpenCLExtensionTypes.def - Metadata about BuiltinTypes --*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/Basic/RISCVVTypes.def b/clang/include/clang/Basic/RISCVVTypes.def index 6620de8ad50e01..ccb8cb39068e2b 100644 --- a/clang/include/clang/Basic/RISCVVTypes.def +++ b/clang/include/clang/Basic/RISCVVTypes.def @@ -383,7 +383,7 @@ RVV_VECTOR_TYPE_INT("__rvv_uint64m2x4_t", RvvUint64m2x4, RvvUint64m2x4Ty, 2, 64, RVV_VECTOR_TYPE_INT("__rvv_uint64m4x2_t",
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
pogo59 wrote: I grepped `clang` for "^/+=[^/]*/.*\.(h|cpp) " and found only 35 files with directory components. So, the majority of files have only the filename in the header line. The example in the Coding Standard does not reflect common practice. I think it's fine to remove everything but the filename. https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
steakhal wrote: I did some grepping. Inside the `clang` project: `^/+=(.*)/(.*)...$`: 297 files `^/+=([^\n/]*)\.(h|cpp)([^\n/]*)...$`: 1766 files This suggests to me that indeed, absolute paths are the used way fewer times. https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
steakhal wrote: > +1 to @pogo59's comment about pruning complete paths - I suspect they're in > the minority. Might be worth checking whether the `===` at the start and end > is markup for any particular thing (I /think/ the `-*- C++ -*-` is load > bearing for some editors to inform them this `.h` file is C++ not C, so I'm > not sure about some other features of those top-of-file comments). According to the [LLVM Coding Standard](https://llvm.org/docs/CodingStandards.html#file-headers), it should look like this: ``` //===-- llvm/Instruction.h - Instruction class definition ---*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===--===// /// /// \file /// This file contains the declaration of the Instruction class, which is the /// base class for all of the VM instructions. /// //===--===// ``` And also explicitly notes: > This tag ["-*- C++ -*-"] is not necessary in .cpp files. The name of the file > is also on the first line, along with a very short description of the purpose > of the file. I could probably interpret this as we could drop the path to the file, but keep the last part. How should I proceed? https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
dwblaikie wrote: +1 to @pogo59's comment about pruning complete paths - I suspect they're in the minority. Might be worth checking whether the `===` at the start and end is markup for any particular thing (I /think/ the `-*- C++ -*-` is load bearing for some editors to inform them this `.h` file is C++ not C, so I'm not sure about some other features of those top-of-file comments). https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
@@ -1,10 +1,10 @@ -//===- unittest/ASTMatchers/Dynamic/VariantValueTest.cpp - VariantValue unit tests -===// +// unittest/ASTMatchers/Dynamic/VariantValueTest.cpp - VariantValue unit tests pogo59 wrote: Repeating the full path name seems unnecessary? (In various files.) https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
https://github.com/NagyDonat approved this pull request. https://github.com/llvm/llvm-project/pull/82919 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
llvmbot wrote: @llvm/pr-subscribers-clang Author: Balazs Benics (steakhal) Changes clang-format would format these headers poorly by splitting it into multiple lines. ```regex //=.{78,} ``` --- Patch is 25.48 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/82919.diff 36 Files Affected: - (modified) clang/include/clang/AST/DeclOpenMP.h (+1-1) - (modified) clang/include/clang/AST/ParentMapContext.h (+1-1) - (modified) clang/include/clang/Basic/OpenCLExtensionTypes.def (+1-1) - (modified) clang/include/clang/Basic/RISCVVTypes.def (+4-4) - (modified) clang/include/clang/Basic/arm_neon_incl.td (+1-1) - (modified) clang/include/clang/Serialization/PCHContainerOperations.h (+1-1) - (modified) clang/include/clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h (+1-1) - (modified) clang/lib/ARCMigrate/TransGCAttrs.cpp (+1-1) - (modified) clang/lib/AST/Interp/ByteCodeEmitter.h (+1-1) - (modified) clang/lib/AST/Interp/FunctionPointer.h (+1-1) - (modified) clang/lib/AST/Interp/PrimType.h (+1-1) - (modified) clang/lib/Driver/ToolChains/Arch/Mips.h (+1-1) - (modified) clang/lib/Driver/ToolChains/Arch/Sparc.h (+1-1) - (modified) clang/lib/Headers/llvm_libc_wrappers/assert.h (+1-1) - (modified) clang/lib/Sema/AnalysisBasedWarnings.cpp (+1-1) - (modified) clang/lib/Sema/SemaChecking.cpp (+1-1) - (modified) clang/lib/StaticAnalyzer/Checkers/DirectIvarAssignment.cpp (+1-1) - (modified) clang/lib/StaticAnalyzer/Checkers/ObjCAutoreleaseWriteChecker.cpp (+1-1) - (modified) clang/lib/StaticAnalyzer/Checkers/STLAlgorithmModeling.cpp (+1-1) - (modified) clang/lib/StaticAnalyzer/Checkers/SimpleStreamChecker.cpp (+1-1) - (modified) clang/lib/StaticAnalyzer/Core/RangeConstraintManager.cpp (+1-1) - (modified) clang/lib/Tooling/Refactoring/AtomicChange.cpp (+1-1) - (modified) clang/test/Analysis/misc-ps-region-store.mm (+2-2) - (modified) clang/test/Rewriter/rewrite-modern-class.mm (+1-1) - (modified) clang/tools/clang-fuzzer/proto-to-llvm/loop_proto_to_llvm.h (+1-1) - (modified) clang/tools/diagtool/DiagTool.cpp (+1-1) - (modified) clang/unittests/AST/ASTImporterODRStrategiesTest.cpp (+1-1) - (modified) clang/unittests/ASTMatchers/Dynamic/RegistryTest.cpp (+2-2) - (modified) clang/unittests/ASTMatchers/Dynamic/VariantValueTest.cpp (+2-2) - (modified) clang/unittests/Tooling/RecursiveASTVisitorTests/CXXOperatorCallExprTraverser.cpp (+1-1) - (modified) clang/unittests/Tooling/RecursiveASTVisitorTests/CallbacksBinaryOperator.cpp (+2-2) - (modified) clang/unittests/Tooling/RecursiveASTVisitorTests/CallbacksCompoundAssignOperator.cpp (+1-1) - (modified) clang/unittests/Tooling/RecursiveASTVisitorTests/CallbacksUnaryOperator.cpp (+2-2) - (modified) clang/unittests/Tooling/RecursiveASTVisitorTests/InitListExprPostOrderNoQueue.cpp (+1-1) - (modified) clang/unittests/Tooling/RecursiveASTVisitorTests/InitListExprPreOrderNoQueue.cpp (+1-1) - (modified) clang/unittests/Tooling/RecursiveASTVisitorTests/TemplateArgumentLocTraverser.cpp (+1-1) ``diff diff --git a/clang/include/clang/AST/DeclOpenMP.h b/clang/include/clang/AST/DeclOpenMP.h index 73725e6e85666a..8fdfddb6c1fd74 100644 --- a/clang/include/clang/AST/DeclOpenMP.h +++ b/clang/include/clang/AST/DeclOpenMP.h @@ -1,4 +1,4 @@ -//===- DeclOpenMP.h - Classes for representing OpenMP directives -*- C++ -*-===// +//===- DeclOpenMP.h - Classes for representing OpenMP directives -*- C++ -*-==// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/AST/ParentMapContext.h b/clang/include/clang/AST/ParentMapContext.h index d3b2e3986a9935..6f79038627d9e1 100644 --- a/clang/include/clang/AST/ParentMapContext.h +++ b/clang/include/clang/AST/ParentMapContext.h @@ -1,4 +1,4 @@ -//===- ParentMapContext.h - Map of parents using DynTypedNode ---*- C++ -*-===// +//===- ParentMapContext.h - Map of parents using DynTypedNode ---*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/Basic/OpenCLExtensionTypes.def b/clang/include/clang/Basic/OpenCLExtensionTypes.def index 17c72d69a02065..50ea826c18a77c 100644 --- a/clang/include/clang/Basic/OpenCLExtensionTypes.def +++ b/clang/include/clang/Basic/OpenCLExtensionTypes.def @@ -1,4 +1,4 @@ -//===-- OpenCLExtensionTypes.def - Metadata about BuiltinTypes --*- C++ -*-===// +//===-- OpenCLExtensionTypes.def - Metadata about BuiltinTypes --*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/Basic/RISCVVTypes.def b/clang/include/clang/Basic/RISCVVTypes.def index 6620de8ad50e01..ccb8cb39068e2b 100644 ---
[clang] [clang][NFC] Trim license header comments to 81 characters (PR #82919)
https://github.com/steakhal created https://github.com/llvm/llvm-project/pull/82919 clang-format would format these headers poorly by splitting it into multiple lines. ```regex //=.{78,} ``` >From 319329630e0d2a86b22dd435985026ea236f8e56 Mon Sep 17 00:00:00 2001 From: Balazs Benics Date: Sun, 25 Feb 2024 12:48:06 +0100 Subject: [PATCH] [clang][NFC] Trim license header comments to 81 characters clang-format would format these headers poorly by splitting it into multiple lines. ```regex //=.{78,} ``` --- clang/include/clang/AST/DeclOpenMP.h | 2 +- clang/include/clang/AST/ParentMapContext.h| 2 +- clang/include/clang/Basic/OpenCLExtensionTypes.def| 2 +- clang/include/clang/Basic/RISCVVTypes.def | 8 clang/include/clang/Basic/arm_neon_incl.td| 2 +- .../include/clang/Serialization/PCHContainerOperations.h | 2 +- .../clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h | 2 +- clang/lib/ARCMigrate/TransGCAttrs.cpp | 2 +- clang/lib/AST/Interp/ByteCodeEmitter.h| 2 +- clang/lib/AST/Interp/FunctionPointer.h| 2 +- clang/lib/AST/Interp/PrimType.h | 2 +- clang/lib/Driver/ToolChains/Arch/Mips.h | 2 +- clang/lib/Driver/ToolChains/Arch/Sparc.h | 2 +- clang/lib/Headers/llvm_libc_wrappers/assert.h | 2 +- clang/lib/Sema/AnalysisBasedWarnings.cpp | 2 +- clang/lib/Sema/SemaChecking.cpp | 2 +- .../lib/StaticAnalyzer/Checkers/DirectIvarAssignment.cpp | 2 +- .../Checkers/ObjCAutoreleaseWriteChecker.cpp | 2 +- .../lib/StaticAnalyzer/Checkers/STLAlgorithmModeling.cpp | 2 +- clang/lib/StaticAnalyzer/Checkers/SimpleStreamChecker.cpp | 2 +- clang/lib/StaticAnalyzer/Core/RangeConstraintManager.cpp | 2 +- clang/lib/Tooling/Refactoring/AtomicChange.cpp| 2 +- clang/test/Analysis/misc-ps-region-store.mm | 4 ++-- clang/test/Rewriter/rewrite-modern-class.mm | 2 +- .../tools/clang-fuzzer/proto-to-llvm/loop_proto_to_llvm.h | 2 +- clang/tools/diagtool/DiagTool.cpp | 2 +- clang/unittests/AST/ASTImporterODRStrategiesTest.cpp | 2 +- clang/unittests/ASTMatchers/Dynamic/RegistryTest.cpp | 4 ++-- clang/unittests/ASTMatchers/Dynamic/VariantValueTest.cpp | 4 ++-- .../CXXOperatorCallExprTraverser.cpp | 2 +- .../RecursiveASTVisitorTests/CallbacksBinaryOperator.cpp | 4 ++-- .../CallbacksCompoundAssignOperator.cpp | 2 +- .../RecursiveASTVisitorTests/CallbacksUnaryOperator.cpp | 4 ++-- .../InitListExprPostOrderNoQueue.cpp | 2 +- .../InitListExprPreOrderNoQueue.cpp | 2 +- .../TemplateArgumentLocTraverser.cpp | 2 +- 36 files changed, 44 insertions(+), 44 deletions(-) diff --git a/clang/include/clang/AST/DeclOpenMP.h b/clang/include/clang/AST/DeclOpenMP.h index 73725e6e85666a..8fdfddb6c1fd74 100644 --- a/clang/include/clang/AST/DeclOpenMP.h +++ b/clang/include/clang/AST/DeclOpenMP.h @@ -1,4 +1,4 @@ -//===- DeclOpenMP.h - Classes for representing OpenMP directives -*- C++ -*-===// +//===- DeclOpenMP.h - Classes for representing OpenMP directives -*- C++ -*-==// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/AST/ParentMapContext.h b/clang/include/clang/AST/ParentMapContext.h index d3b2e3986a9935..6f79038627d9e1 100644 --- a/clang/include/clang/AST/ParentMapContext.h +++ b/clang/include/clang/AST/ParentMapContext.h @@ -1,4 +1,4 @@ -//===- ParentMapContext.h - Map of parents using DynTypedNode ---*- C++ -*-===// +//===- ParentMapContext.h - Map of parents using DynTypedNode ---*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/Basic/OpenCLExtensionTypes.def b/clang/include/clang/Basic/OpenCLExtensionTypes.def index 17c72d69a02065..50ea826c18a77c 100644 --- a/clang/include/clang/Basic/OpenCLExtensionTypes.def +++ b/clang/include/clang/Basic/OpenCLExtensionTypes.def @@ -1,4 +1,4 @@ -//===-- OpenCLExtensionTypes.def - Metadata about BuiltinTypes --*- C++ -*-===// +//===-- OpenCLExtensionTypes.def - Metadata about BuiltinTypes --*- C++ -*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. diff --git a/clang/include/clang/Basic/RISCVVTypes.def b/clang/include/clang/Basic/RISCVVTypes.def index 6620de8ad50e01..ccb8cb39068e2b 100644 --- a/clang/include/clang/Basic/RISCVVTypes.def +++ b/clang/include/clang/Basic/RISCVVTypes.def @@ -383,7 +383,7 @@