From fc3c693b617fc5fde8939a3aec7e7372ace07693 Mon Sep 17 00:00:00 2001 From: Nathan James Date: Mon, 6 Jul 2020 14:39:02 +0100 Subject: [PATCH] [clang-tidy] Added alias llvm-else-after-return. Added an alias llvm-else-after-return from readability-else-after-return to help enforce one of the llvm coding guidelines. Reviewed By: aaron.ballman Differential Revision: https://reviews.llvm.org/D82825 --- clang-tools-extra/clang-tidy/llvm/LLVMTidyModule.cpp | 6 ++++++ clang-tools-extra/docs/ReleaseNotes.rst | 5 +++++ clang-tools-extra/docs/clang-tidy/checks/list.rst | 1 + .../docs/clang-tidy/checks/llvm-else-after-return.rst | 11 +++++++++++ .../docs/clang-tidy/checks/readability-else-after-return.rst | 10 ++++++++++ 5 files changed, 33 insertions(+) create mode 100644 clang-tools-extra/docs/clang-tidy/checks/llvm-else-after-return.rst diff --git a/clang-tools-extra/clang-tidy/llvm/LLVMTidyModule.cpp b/clang-tools-extra/clang-tidy/llvm/LLVMTidyModule.cpp index 2aaf076..0310a8e 100644 --- a/clang-tools-extra/clang-tidy/llvm/LLVMTidyModule.cpp +++ b/clang-tools-extra/clang-tidy/llvm/LLVMTidyModule.cpp @@ -9,6 +9,7 @@ #include "../ClangTidy.h" #include "../ClangTidyModule.h" #include "../ClangTidyModuleRegistry.h" +#include "../readability/ElseAfterReturnCheck.h" #include "../readability/NamespaceCommentCheck.h" #include "../readability/QualifiedAutoCheck.h" #include "HeaderGuardCheck.h" @@ -24,6 +25,8 @@ namespace llvm_check { class LLVMModule : public ClangTidyModule { public: void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override { + CheckFactories.registerCheck( + "llvm-else-after-return"); CheckFactories.registerCheck("llvm-header-guard"); CheckFactories.registerCheck("llvm-include-order"); CheckFactories.registerCheck( @@ -40,6 +43,9 @@ public: ClangTidyOptions getModuleOptions() override { ClangTidyOptions Options; Options.CheckOptions["llvm-qualified-auto.AddConstToQualified"] = "0"; + Options.CheckOptions["llvm-else-after-return.WarnOnUnfixable"] = "0"; + Options.CheckOptions["llvm-else-after-return.RefactorConditionVariables"] = + "0"; return Options; } }; diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index 7593554..c66d5eb 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -192,6 +192,11 @@ New check aliases :doc:`bugprone-signed-char-misuse ` was added. +- New alias :doc:`llvm-else-after-return + ` to + :doc:`readability-else-after-return + ` was added. + Changes in existing checks ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst index baa142e..7356c58 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -423,4 +423,5 @@ Clang-Tidy Checks `hicpp-use-nullptr `_, `modernize-use-nullptr `_, "Yes" `hicpp-use-override `_, `modernize-use-override `_, "Yes" `hicpp-vararg `_, `cppcoreguidelines-pro-type-vararg `_, + `llvm-else-after-return `_, `readability-else-after-return `_, "Yes" `llvm-qualified-auto `_, `readability-qualified-auto `_, "Yes" diff --git a/clang-tools-extra/docs/clang-tidy/checks/llvm-else-after-return.rst b/clang-tools-extra/docs/clang-tidy/checks/llvm-else-after-return.rst new file mode 100644 index 0000000..f9af610 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/llvm-else-after-return.rst @@ -0,0 +1,11 @@ +.. title:: clang-tidy - llvm-else-after-return +.. meta:: + :http-equiv=refresh: 5;URL=readability-else-after-return.html + +llvm-else-after-return +====================== + +The llvm-else-after-return check is an alias, please see +`readability-else-after-return `_ +for more information. + diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst index fccb01d..4adcd7b 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst @@ -77,3 +77,13 @@ Options the ``if`` statement is the last statement in its parents scope. Default value is `true`. + +LLVM alias +---------- + +There is an alias of this check called llvm-else-after-return. +In that version the options :option:`WarnOnUnfixable` and +:option:`WarnOnConditionVariables` are both set to `false` by default. + +This check helps to enforce this `LLVM Coding Standards recommendation +`_. -- 2.7.4