summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs
diff options
context:
space:
mode:
Diffstat (limited to 'clang-tools-extra/docs')
-rw-r--r--clang-tools-extra/docs/ReleaseNotes.rst6
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/abseil-str-cat-append.rst17
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/list.rst1
3 files changed, 24 insertions, 0 deletions
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 6f39c924e83..d1d7f4a1f62 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -76,6 +76,12 @@ Improvements to clang-tidy
Ensures code does not open ``namespace absl`` as that violates Abseil's
compatibility guidelines.
+- New :doc:`abseil-str-cat-append
+ <clang-tidy/checks/abseil-str-cat-append>` check.
+
+ Flags uses of ``absl::StrCat()`` to append to a ``std::string``. Suggests
+ ``absl::StrAppend()`` should be used instead.
+
- New :doc:`readability-magic-numbers
<clang-tidy/checks/readability-magic-numbers>` check.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/abseil-str-cat-append.rst b/clang-tools-extra/docs/clang-tidy/checks/abseil-str-cat-append.rst
new file mode 100644
index 00000000000..7ab1069b567
--- /dev/null
+++ b/clang-tools-extra/docs/clang-tidy/checks/abseil-str-cat-append.rst
@@ -0,0 +1,17 @@
+.. title:: clang-tidy - abseil-str-cat-append
+
+abseil-str-cat-append
+=====================
+
+Flags uses of ``absl::StrCat()`` to append to a ``std::string``. Suggests
+``absl::StrAppend()`` should be used instead.
+
+The extra calls cause unnecessary temporary strings to be constructed. Removing
+them makes the code smaller and faster.
+
+.. code-block:: c++
+
+ a = absl::StrCat(a, b); // Use absl::StrAppend(&a, b) instead.
+
+Does not diagnose cases where ``abls::StrCat()`` is used as a template
+argument for a functor.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst
index c52f030a6d1..bde9285fb6a 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -8,6 +8,7 @@ Clang-Tidy Checks
abseil-faster-strsplit-delimiter
abseil-no-namespace
abseil-string-find-startswith
+ abseil-str-cat-append
android-cloexec-accept
android-cloexec-accept4
android-cloexec-creat
OpenPOWER on IntegriCloud