From f5f9bf415ce118478e841922b13dba5a03ea8ba4 Mon Sep 17 00:00:00 2001 From: Aaron Ballman Date: Mon, 11 Jan 2016 16:48:26 +0000 Subject: Add documentation redirects for clang-tidy checkers that are exposed under multiple checker names. Updates the Python script for adding checks to properly handle these aliases. llvm-svn: 257347 --- clang-tools-extra/docs/clang-tidy/checks/cert-dcl03-c.rst | 9 +++++++++ clang-tools-extra/docs/clang-tidy/checks/cert-dcl54-cpp.rst | 10 ++++++++++ clang-tools-extra/docs/clang-tidy/checks/cert-dcl59-cpp.rst | 9 +++++++++ clang-tools-extra/docs/clang-tidy/checks/cert-err61-cpp.rst | 10 ++++++++++ clang-tools-extra/docs/clang-tidy/checks/cert-fio38-c.rst | 10 ++++++++++ clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst | 10 ++++++++++ .../docs/clang-tidy/checks/google-build-namespaces.rst | 1 + clang-tools-extra/docs/clang-tidy/checks/list.rst | 6 ++++++ .../docs/clang-tidy/checks/misc-move-constructor-init.rst | 1 + .../docs/clang-tidy/checks/misc-new-delete-overloads.rst | 2 ++ .../docs/clang-tidy/checks/misc-non-copyable-objects.rst | 2 ++ .../docs/clang-tidy/checks/misc-static-assert.rst | 1 + .../checks/misc-throw-by-value-catch-by-reference.rst | 2 ++ 13 files changed, 73 insertions(+) create mode 100644 clang-tools-extra/docs/clang-tidy/checks/cert-dcl03-c.rst create mode 100644 clang-tools-extra/docs/clang-tidy/checks/cert-dcl54-cpp.rst create mode 100644 clang-tools-extra/docs/clang-tidy/checks/cert-dcl59-cpp.rst create mode 100644 clang-tools-extra/docs/clang-tidy/checks/cert-err61-cpp.rst create mode 100644 clang-tools-extra/docs/clang-tidy/checks/cert-fio38-c.rst create mode 100644 clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst (limited to 'clang-tools-extra/docs/clang-tidy') diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-dcl03-c.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-dcl03-c.rst new file mode 100644 index 00000000000..cd384ff7f9b --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cert-dcl03-c.rst @@ -0,0 +1,9 @@ +.. title:: clang-tidy - cert-dcl03-c +.. meta:: + :http-equiv=refresh: 5;URL=misc-static-assert.html + +cert-dcl03-c +============ + +The cert-dcl03-c checker is an alias, please see +`misc-static-assert `_ for more information. diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-dcl54-cpp.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-dcl54-cpp.rst new file mode 100644 index 00000000000..7aba1e2bc49 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cert-dcl54-cpp.rst @@ -0,0 +1,10 @@ +.. title:: clang-tidy - cert-dcl54-cpp +.. meta:: + :http-equiv=refresh: 5;URL=misc-new-delete-overloads.html + +cert-dcl54-cpp +============== + +The cert-dcl54-cpp checker is an alias, please see +`misc-new-delete-overloads `_ for more +information. diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-dcl59-cpp.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-dcl59-cpp.rst new file mode 100644 index 00000000000..b8808ce9812 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cert-dcl59-cpp.rst @@ -0,0 +1,9 @@ +.. title:: clang-tidy - cert-dcl59-cpp +.. meta:: + :http-equiv=refresh: 5;URL=google-build-namespaces.html + +cert-dcl59-cpp +============== + +The cert-dcl59-cpp checker is an alias, please see +`google-build-namespaces `_ for more information. diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-err61-cpp.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-err61-cpp.rst new file mode 100644 index 00000000000..2657836d9a9 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cert-err61-cpp.rst @@ -0,0 +1,10 @@ +.. title:: clang-tidy - cert-err61-cpp +.. meta:: + :http-equiv=refresh: 5;URL=misc-throw-by-value-catch-by-reference.html + +cert-err61-cpp +============== + +The cert-err61-cpp checker is an alias, please see +`misc-throw-by-value-catch-by-reference `_ +for more information. diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-fio38-c.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-fio38-c.rst new file mode 100644 index 00000000000..3202790f94d --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cert-fio38-c.rst @@ -0,0 +1,10 @@ +.. title:: clang-tidy - cert-fio38-c +.. meta:: + :http-equiv=refresh: 5;URL=misc-non-copyable-objects.html + +cert-fio38-c +============ + +The cert-fio38-c checker is an alias, please see +`misc-non-copyable-objects `_ for more +information. diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst new file mode 100644 index 00000000000..cc72d388674 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/cert-oop11-cpp.rst @@ -0,0 +1,10 @@ +.. title:: clang-tidy - cert-oop11-cpp +.. meta:: + :http-equiv=refresh: 5;URL=misc-move-constructor-init.html + +cert-oop11-cpp +============== + +The cert-oop11-cpp checker is an alias, please see +`misc-move-constructor-init `_ for more +information. diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst b/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst index c39157624f1..63718a69a3c 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst @@ -3,6 +3,7 @@ google-build-namespaces ======================= +"cert-dcl59-cpp" redirects here as an alias for this checker. Finds anonymous namespaces in headers. diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst index f72ea4b392e..bee3eef6e4a 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -4,10 +4,16 @@ Clang-Tidy Checks ========================= .. toctree:: + cert-dcl03-c (redirects to misc-static-assert) cert-dcl50-cpp + cert-dcl54-cpp (redirects to misc-new-delete-overloads) + cert-dcl59-cpp (redirects to google-build-namespaces) cert-err52-cpp cert-err58-cpp cert-err60-cpp + cert-err61-cpp (redirects to misc-throw-by-value-catch-by-reference) + cert-fio38-c (redirects to misc-non-copyable-objects) + cert-oop11-cpp (redirects to misc-move-constructor-init) cppcoreguidelines-pro-bounds-array-to-pointer-decay cppcoreguidelines-pro-bounds-constant-array-index cppcoreguidelines-pro-bounds-pointer-arithmetic diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst index 67c293a7447..85e99a4557a 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst @@ -3,6 +3,7 @@ misc-move-constructor-init ========================== +"cert-oop11-cpp" redirects here as an alias for this checker. The check flags user-defined move constructors that have a ctor-initializer initializing a member or base class through a copy constructor instead of a diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst index 454af77a9e1..ba5960916f9 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst @@ -3,6 +3,8 @@ misc-new-delete-overloads ========================= +"cert-dcl54-cpp" redirects here as an alias for this checker. + The check flags overloaded operator new() and operator delete() functions that do not have a corresponding free store function defined within the same scope. For instance, the check will flag a class implementation of a non-placement diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst index 6d4c0fd5956..3f3f29eb0af 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst @@ -3,6 +3,8 @@ misc-non-copyable-objects ========================= +"cert-fio38-c" redirects here as an alias for this checker. + The check flags dereferences and non-pointer declarations of objects that are not meant to be passed by value, such as C FILE objects or POSIX pthread_mutex_t objects. diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst index b93a8caf660..0002bdd31b5 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst @@ -3,6 +3,7 @@ misc-static-assert ================== +"cert-dcl03-c" redirects here as an alias for this checker. Replaces ``assert()`` with ``static_assert()`` if the condition is evaluatable at compile time. diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst index 2befb75b0fd..388d704d37c 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst @@ -3,6 +3,8 @@ misc-throw-by-value-catch-by-reference ====================================== +"cert-err61-cpp" redirects here as an alias for this checker. + Finds violations of the rule "Throw by value, catch by reference" presented for example in "C++ Coding Standards" by H. Sutter and A. Alexandrescu. This check also has the option to find violations of the rule "Throw anonymous temporaries" (https://www.securecoding.cert.org/confluence/display/cplusplus/ERR09-CPP.+Throw+anonymous+temporaries). The option is named "CheckThrowTemporaries" and it's on by default. Exceptions: -- cgit v1.2.3