From 834bb0e3b51e33e4142494e96544a500e98a17d1 Mon Sep 17 00:00:00 2001 From: Eugene Zelenko Date: Thu, 26 Jan 2017 23:58:21 +0000 Subject: [PATCH] [Clang-tidy documentation] Consistency (fix-it); 80 characters per line. llvm-svn: 293234 --- .../checks/cppcoreguidelines-no-malloc.rst | 4 ++-- ...idelines-pro-type-static-cast-downcast.rst | 2 +- .../checks/modernize-use-noexcept.rst | 20 +++++++++---------- clang-tools-extra/docs/clang-tidy/index.rst | 4 ++-- 4 files changed, 14 insertions(+), 16 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-no-malloc.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-no-malloc.rst index 7618505fa9c9..0b756becf926 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-no-malloc.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-no-malloc.rst @@ -9,8 +9,8 @@ of an appropriate RAII object. See `C++ Core Guidelines `. -There is no attempt made to provide fixit hints, since manual resource management isn't -easily transformed automatically into RAII. +There is no attempt made to provide fix-it hints, since manual resource +management isn't easily transformed automatically into RAII. .. code-block:: c++ diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst index 1d29af51a27e..880b8b0ee18d 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst @@ -4,7 +4,7 @@ cppcoreguidelines-pro-type-static-cast-downcast =============================================== This check flags all usages of ``static_cast``, where a base class is casted to -a derived class. In those cases, a fixit is provided to convert the cast to a +a derived class. In those cases, a fix-it is provided to convert the cast to a ``dynamic_cast``. Use of these casts can violate type safety and cause the program to access a diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-noexcept.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-noexcept.rst index 8a4b125ac68e..5b681952f3d7 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-noexcept.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-noexcept.rst @@ -29,11 +29,10 @@ Options .. option:: ReplacementString -Users can use :option:`ReplacementString` to specify a macro to use -instead of ``noexcept``. This is useful when maintaining source code -that uses custom exception specification marking other than -``noexcept``. Fixit hints will only be generated for non-throwing -specifications. +Users can use :option:`ReplacementString` to specify a macro to use instead of +``noexcept``. This is useful when maintaining source code that uses custom +exception specification marking other than ``noexcept``. Fix-it hints will only +be generated for non-throwing specifications. Example ^^^^^^^ @@ -47,18 +46,17 @@ transforms to: .. code-block:: c++ - void bar() throw(int); // No Fixit generated. + void bar() throw(int); // No fix-it generated. void foo() NOEXCEPT; if the :option:`ReplacementString` option is set to `NOEXCEPT`. .. option:: UseNoexceptFalse -Enabled by default, disabling will generate Fixit hints that remove -throwing dynamic exception specs, e.g., ``throw()``, -completely without providing a replacement text, except for -destructors and delete operators that are ``noexcept(true)`` by -default. +Enabled by default, disabling will generate fix-it hints that remove throwing +dynamic exception specs, e.g., ``throw()``, completely without +providing a replacement text, except for destructors and delete operators that +are ``noexcept(true)`` by default. Example ^^^^^^^ diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst index fdf0adbe7dbf..a414bf1aca0a 100644 --- a/clang-tools-extra/docs/clang-tidy/index.rst +++ b/clang-tools-extra/docs/clang-tidy/index.rst @@ -549,9 +549,9 @@ file, runs :program:`clang-tidy` and verifies messages and fixes with two separate `FileCheck`_ invocations: once with FileCheck's directive prefix set to ``CHECK-MESSAGES``, validating the diagnostic messages, and once with the directive prefix set to ``CHECK-FIXES``, running -against the fixed code (i.e., the code after generated fixits are +against the fixed code (i.e., the code after generated fix-its are applied). In particular, ``CHECK-FIXES:`` can be used to check -that code was not modified by fixits, by checking that it is present +that code was not modified by fix-its, by checking that it is present unchanged in the fixed code. The full set of `FileCheck`_ directives is available (e.g., ``CHECK-MESSAGES-SAME:``, ``CHECK-MESSAGES-NOT:``), though typically the basic ``CHECK`` forms (``CHECK-MESSAGES`` and ``CHECK-FIXES``)