[clang] 3a14993 - Fix typos in documentation

Kazu Hirata via cfe-commits cfe-commits at lists.llvm.org
Sun Aug 27 00:18:27 PDT 2023


Author: Kazu Hirata
Date: 2023-08-27T00:18:14-07:00
New Revision: 3a14993fa428c67634c979107ca6ddaafeb7037b

URL: https://github.com/llvm/llvm-project/commit/3a14993fa428c67634c979107ca6ddaafeb7037b
DIFF: https://github.com/llvm/llvm-project/commit/3a14993fa428c67634c979107ca6ddaafeb7037b.diff

LOG: Fix typos in documentation

Added: 
    

Modified: 
    clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.DeprecatedOrUnsafeBufferHandling.rst
    clang/docs/LanguageExtensions.rst
    clang/docs/ReleaseNotes.rst
    clang/docs/analyzer/developer-docs/nullability.rst
    lldb/docs/python_api_enums.rst
    llvm/docs/AMDGPUUsage.rst
    llvm/docs/Atomics.rst
    llvm/docs/Coroutines.rst
    llvm/docs/GlobalISel/MIRPatterns.rst
    llvm/docs/MyFirstTypoFix.rst

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.DeprecatedOrUnsafeBufferHandling.rst b/clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.DeprecatedOrUnsafeBufferHandling.rst
index 8a8880805af702..7b365346b4b39f 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.DeprecatedOrUnsafeBufferHandling.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.DeprecatedOrUnsafeBufferHandling.rst
@@ -5,7 +5,7 @@
 clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling
 ====================================================================
 
-Warn on uses of unsecure or deprecated buffer manipulating functions.
+Warn on uses of insecure or deprecated buffer manipulating functions.
 
 The `clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling` check is an alias, please see
 `Clang Static Analyzer Available Checkers

diff  --git a/clang/docs/LanguageExtensions.rst b/clang/docs/LanguageExtensions.rst
index a51dea03fcb655..e739ecf3b9df4a 100644
--- a/clang/docs/LanguageExtensions.rst
+++ b/clang/docs/LanguageExtensions.rst
@@ -3163,7 +3163,7 @@ avoid cache misses when the developer has a good understanding of which data
 are going to be used next. ``addr`` is the address that needs to be brought into
 the cache. ``rw`` indicates the expected access mode: ``0`` for *read* and ``1``
 for *write*. In case of *read write* access, ``1`` is to be used. ``locality``
-indicates the expected persistance of data in cache, from ``0`` which means that
+indicates the expected persistence of data in cache, from ``0`` which means that
 data can be discarded from cache after its next use to ``3`` which means that
 data is going to be reused a lot once in cache. ``1`` and ``2`` provide
 intermediate behavior between these two extremes.

diff  --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst
index 1ba4215e603349..1ed144cea09786 100644
--- a/clang/docs/ReleaseNotes.rst
+++ b/clang/docs/ReleaseNotes.rst
@@ -221,7 +221,7 @@ Bug Fixes to C++ Support
 
 - Expressions producing ``nullptr`` are correctly evaluated
   by the constant interpreter when appearing as the operand
-  of a binary comparision.
+  of a binary comparison.
   (`#64923 <https://github.com/llvm/llvm-project/issues/64923>_``)
 
 - Fix a crash when an immediate invocation is not a constant expression

diff  --git a/clang/docs/analyzer/developer-docs/nullability.rst b/clang/docs/analyzer/developer-docs/nullability.rst
index 70e1958634ad9f..dc24793a8f4fc0 100644
--- a/clang/docs/analyzer/developer-docs/nullability.rst
+++ b/clang/docs/analyzer/developer-docs/nullability.rst
@@ -62,7 +62,7 @@ Other Issues to keep in mind/take care of:
     * Even though the method might return a nonnull pointer, when it was sent to a nullable pointer the return type will be nullable.
   	* The result is nullable unless the receiver is known to be non null.
 
-  * Sending a message to a unspecified or nonnull pointer
+  * Sending a message to an unspecified or nonnull pointer
 
     * If the pointer is not assumed to be nil, we should be optimistic and use the nullability implied by the method.
 

diff  --git a/lldb/docs/python_api_enums.rst b/lldb/docs/python_api_enums.rst
index e34f4656b6ad88..b6a2497ea878e0 100644
--- a/lldb/docs/python_api_enums.rst
+++ b/lldb/docs/python_api_enums.rst
@@ -504,7 +504,7 @@ ValueType
 
 .. py:data:: eValueTypeVariableArgument
 
-   Funfction argument variable.
+   Function argument variable.
 
 .. py:data:: eValueTypeVariableLocal
 

diff  --git a/llvm/docs/AMDGPUUsage.rst b/llvm/docs/AMDGPUUsage.rst
index c3b3927c4f0f7e..0db4cdf0a5db44 100644
--- a/llvm/docs/AMDGPUUsage.rst
+++ b/llvm/docs/AMDGPUUsage.rst
@@ -966,10 +966,10 @@ The AMDGPU backend implements the following LLVM IR intrinsics.
   LLVM Intrinsic                                   Description
   ==============================================   ==========================================================
   llvm.amdgcn.sqrt                                 Provides direct access to v_sqrt_f64, v_sqrt_f32 and v_sqrt_f16
-                                                   (on targets with half support). Peforms sqrt function.
+                                                   (on targets with half support). Performs sqrt function.
 
   llvm.amdgcn.log                                  Provides direct access to v_log_f32 and v_log_f16
-                                                   (on targets with half support). Peforms log2 function.
+                                                   (on targets with half support). Performs log2 function.
 
   llvm.amdgcn.exp2                                 Provides direct access to v_exp_f32 and v_exp_f16
                                                    (on targets with half support). Performs exp2 function.

diff  --git a/llvm/docs/Atomics.rst b/llvm/docs/Atomics.rst
index 3e2cfe4b3e288b..f64a0aa89b77de 100644
--- a/llvm/docs/Atomics.rst
+++ b/llvm/docs/Atomics.rst
@@ -286,7 +286,7 @@ Relevant standard
 
 Notes for frontends
   If you are writing a frontend which uses this directly, use with caution.
-  Release only provides a semantic guarantee when paired with a Acquire
+  Release only provides a semantic guarantee when paired with an Acquire
   operation.
 
 Notes for optimizers

diff  --git a/llvm/docs/Coroutines.rst b/llvm/docs/Coroutines.rst
index 117c8b55569488..37c0614b3985db 100644
--- a/llvm/docs/Coroutines.rst
+++ b/llvm/docs/Coroutines.rst
@@ -1606,7 +1606,7 @@ Overview:
 """""""""
 
 The '``llvm.coro.suspend.async``' intrinsic marks the point where
-execution of a async coroutine is suspended and control is passed to a callee.
+execution of an async coroutine is suspended and control is passed to a callee.
 
 Arguments:
 """"""""""

diff  --git a/llvm/docs/GlobalISel/MIRPatterns.rst b/llvm/docs/GlobalISel/MIRPatterns.rst
index 493f9693a2b769..72535ea42254f9 100644
--- a/llvm/docs/GlobalISel/MIRPatterns.rst
+++ b/llvm/docs/GlobalISel/MIRPatterns.rst
@@ -63,7 +63,7 @@ Semantics:
     other patterns in that rule/alternative can simply use ``$x``
     (``i32:$x`` is redundant).
 
-* A nammed operand's behavior depends on whether the name has been seen before.
+* A named operand's behavior depends on whether the name has been seen before.
 
   * For match patterns, reusing an operand name checks that the operands
     are identical (see example 2 below).

diff  --git a/llvm/docs/MyFirstTypoFix.rst b/llvm/docs/MyFirstTypoFix.rst
index dc032375bf9fa6..f1ce39a44ac1cd 100644
--- a/llvm/docs/MyFirstTypoFix.rst
+++ b/llvm/docs/MyFirstTypoFix.rst
@@ -316,7 +316,7 @@ the change was made.
    $ git commit -am "[Diagnostic] Clarify -Winfinite-recursion message"
 
 Now we're ready to send this change out into the world! By the way,
-There is a unwritten convention of using tag for your commit. Tags
+There is an unwritten convention of using tag for your commit. Tags
 usually represent modules that you intend to modify. If you don't know
 the tags for your modules, you can look at the commit history :
 https://github.com/llvm/llvm-project/commits/main.


        


More information about the cfe-commits mailing list