From 75de6146843419a0a94b01fedf82324e6880bbc5 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 10 Aug 2017 10:12:31 +0000 Subject: [PATCH] [clang-tidy] add forwarders in the aliased checks from hicpp module Summary: Adds redirections notes and the actual redirections in the documentation for hicpp Patch by: Jonas Toth Reviewers: aaron.ballman, hokein, alexfh Reviewed By: aaron.ballman, hokein Subscribers: JDevlieghere, xazax.hun Differential Revision: https://reviews.llvm.org/D36355 llvm-svn: 310577 --- .../checks/hicpp-explicit-conversions.rst | 4 +++- .../docs/clang-tidy/checks/hicpp-function-size.rst | 4 +++- .../checks/hicpp-invalid-access-moved.rst | 4 +++- .../docs/clang-tidy/checks/hicpp-member-init.rst | 4 +++- .../clang-tidy/checks/hicpp-named-parameter.rst | 4 +++- .../checks/hicpp-new-delete-operators.rst | 4 +++- .../docs/clang-tidy/checks/hicpp-noexcept-move.rst | 4 +++- .../checks/hicpp-special-member-functions.rst | 4 +++- .../checks/hicpp-undelegated-constructor.rst | 4 +++- .../clang-tidy/checks/hicpp-use-equals-default.rst | 4 +++- .../clang-tidy/checks/hicpp-use-equals-delete.rst | 4 +++- .../docs/clang-tidy/checks/hicpp-use-override.rst | 4 +++- clang-tools-extra/docs/clang-tidy/checks/list.rst | 24 +++++++++++----------- 13 files changed, 48 insertions(+), 24 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-explicit-conversions.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-explicit-conversions.rst index 1779473..3ee0b78 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-explicit-conversions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-explicit-conversions.rst @@ -1,9 +1,11 @@ .. title:: clang-tidy - hicpp-explicit-conversions +.. meta:: + :http-equiv=refresh: 5;URL=google-explicit-constructor.html hicpp-explicit-conversions ========================== -This check is an alias for `google-explicit-constructor `_. +This check is an alias for `google-explicit-constructor `_. Used to enforce parts of `rule 5.4.1 `_. This check will enforce that constructors and conversion operators are marked `explicit`. Other forms of casting checks are implemented in other places. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-function-size.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-function-size.rst index b82a722..4b1f616 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-function-size.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-function-size.rst @@ -1,9 +1,11 @@ .. title:: clang-tidy - hicpp-function-size +.. meta:: + :http-equiv=refresh: 5;URL=readability-function-size.html hicpp-function-size =================== -This check is an alias for `readability-function-size `_. +This check is an alias for `readability-function-size `_. Useful to enforce multiple sections on function complexity. - `rule 8.2.2 `_ diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-invalid-access-moved.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-invalid-access-moved.rst index d016eae..fa0ed37 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-invalid-access-moved.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-invalid-access-moved.rst @@ -1,8 +1,10 @@ .. title:: clang-tidy - hicpp-invalid-access-moved +.. meta:: + :http-equiv=refresh: 5;URL=misc-use-after-move.html hicpp-invalid-access-moved ========================== -This check is an alias for `misc-use-after-move `_. +This check is an alias for `misc-use-after-move `_. Implements parts of the `rule 8.4.1 `_ to check if moved-from objects are accessed. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-member-init.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-member-init.rst index eb948ae..7f985e2 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-member-init.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-member-init.rst @@ -1,9 +1,11 @@ .. title:: clang-tidy - hicpp-member-init +.. meta:: + :http-equiv=refresh: 5;URL=cppcoreguidelines-pro-type-member-init.html hicpp-member-init ================= -This check is an alias for `cppcoreguidelines-pro-type-member-init `_. +This check is an alias for `cppcoreguidelines-pro-type-member-init `_. Implements the check for `rule 12.4.2 `_ to initialize class members in the right order. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-named-parameter.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-named-parameter.rst index d848d07..4bb8505 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-named-parameter.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-named-parameter.rst @@ -1,8 +1,10 @@ .. title:: clang-tidy - hicpp-named-parameter +.. meta:: + :http-equiv=refresh: 5;URL=readability-named-parameter.html hicpp-named-parameter ===================== -This check is an alias for `readability-named-parameter `_. +This check is an alias for `readability-named-parameter `_. Implements `rule 8.2.1 `_. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-new-delete-operators.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-new-delete-operators.rst index 8994644..88c26ad 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-new-delete-operators.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-new-delete-operators.rst @@ -1,8 +1,10 @@ .. title:: clang-tidy - hicpp-new-delete-operators +.. meta:: + :http-equiv=refresh: 5;URL=misc-new-delete-overloads.html hicpp-new-delete-operators ========================== -This check is an alias for `misc-new-delete-overloads `_. +This check is an alias for `misc-new-delete-overloads `_. Implements `rule 12.3.1 `_ to ensure the `new` and `delete` operators have the correct signature. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-noexcept-move.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-noexcept-move.rst index 0f4505f..10573ec 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-noexcept-move.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-noexcept-move.rst @@ -1,7 +1,9 @@ .. title:: clang-tidy - hicpp-noexcept-move +.. meta:: + :http-equiv=refresh: 5;URL=misc-noexcept-moveconstructor.html hicpp-noexcept-move =================== -This check is an alias for `misc-noexcept-moveconstructor `_. +This check is an alias for `misc-noexcept-moveconstructor `_. Checks `rule 12.5.4 `_ to mark move assignment and move construction `noexcept`. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-special-member-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-special-member-functions.rst index b50c934..4173177 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-special-member-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-special-member-functions.rst @@ -1,7 +1,9 @@ .. title:: clang-tidy - hicpp-special-member-functions +.. meta:: + :http-equiv=refresh: 5;URL=cppcoreguidelines-special-member-functions.html hicpp-special-member-functions ============================== -This check is an alias for `cppcoreguidelines-special-member-functions `_. +This check is an alias for `cppcoreguidelines-special-member-functions `_. Checks that special member functions have the correct signature, according to `rule 12.5.7 `_. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-undelegated-constructor.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-undelegated-constructor.rst index d05d762..730a306 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-undelegated-constructor.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-undelegated-constructor.rst @@ -1,9 +1,11 @@ .. title:: clang-tidy - hicpp-undelegated-construtor +.. meta:: + :http-equiv=refresh: 5;URL=misc-undelegated-constructor.html hicpp-undelegated-constructor ============================= -This check is an alias for `misc-undelegated-constructor `_. +This check is an alias for `misc-undelegated-constructor `_. Partially implements `rule 12.4.5 `_ to find misplaced constructor calls inside a constructor. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-default.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-default.rst index 380ecfc..1dcf581 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-default.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-default.rst @@ -1,7 +1,9 @@ .. title:: clang-tidy - hicpp-use-equals-defaults +.. meta:: + :http-equiv=refresh: 5;URL=modernize-use-equals-default.html hicpp-use-equals-default ======================== -This check is an alias for `modernize-use-equals-default `_. +This check is an alias for `modernize-use-equals-default `_. Implements `rule 12.5.1 `_ to explicitly default special member functions. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-delete.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-delete.rst index c05da23..4d98786 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-delete.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-equals-delete.rst @@ -1,8 +1,10 @@ .. title:: clang-tidy - hicpp-use-equals-delete +.. meta:: + :http-equiv=refresh: 5;URL=modernize-use-equals-delete.html hicpp-use-equals-delete ======================= -This check is an alias for `modernize-use-equals-delete `_. +This check is an alias for `modernize-use-equals-delete `_. Implements `rule 12.5.1 `_ to explicitly default or delete special member functions. diff --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-override.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-override.rst index fa1f158a..62541fa 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-override.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp-use-override.rst @@ -1,8 +1,10 @@ .. title:: clang-tidy - hicpp-use-override +.. meta:: + :http-equiv=refresh: 5;URL=modernize-use-override.html hicpp-use-override ================== -This check is an alias for `modernize-use-override `_. +This check is an alias for `modernize-use-override `_. Implements `rule 10.2.1 `_ to declare a virtual function `override` when overriding. diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst index 8a12c02..3e82ff5 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -60,19 +60,19 @@ Clang-Tidy Checks google-runtime-member-string-references google-runtime-operator google-runtime-references - hicpp-explicit-conversions - hicpp-function-size - hicpp-invalid-access-moved - hicpp-member-init - hicpp-named-parameter - hicpp-new-delete-operators + hicpp-explicit-conversions (redirects to google-explicit-constructor) + hicpp-function-size (redirects to readability-function-size) + hicpp-invalid-access-moved (redirects to misc-use-after-move) + hicpp-member-init (redirects to cppcoreguidelines-pro-type-member-init) + hicpp-named-parameter (redirects to readability-named-parameter) + hicpp-new-delete-operators (redirects to misc-new-delete-overloads) hicpp-no-assembler - hicpp-noexcept-move - hicpp-special-member-functions - hicpp-undelegated-constructor - hicpp-use-equals-default - hicpp-use-equals-delete - hicpp-use-override + hicpp-noexcept-move (redirects to misc-noexcept-moveconstructor) + hicpp-special-member-functions (redirects to cppcoreguidelines-special-member-functions) + hicpp-undelegated-constructor (redirects to misc-undelegated-constructor) + hicpp-use-equals-default (redirects to modernize-use-equals-default) + hicpp-use-equals-delete (redirects to modernize-use-equals-delete) + hicpp-use-override (redirects to modernize-use-override) llvm-header-guard llvm-include-order llvm-namespace-comment -- 2.7.4