[libc-commits] [libc] 282798f - [libc] Fix typos in documentation

Kazu Hirata via libc-commits libc-commits at lists.llvm.org
Sat May 6 11:26:46 PDT 2023


Author: Kazu Hirata
Date: 2023-05-06T11:26:32-07:00
New Revision: 282798fefdafc2c86bcc70c66d764d6b09fc6cb9

URL: https://github.com/llvm/llvm-project/commit/282798fefdafc2c86bcc70c66d764d6b09fc6cb9
DIFF: https://github.com/llvm/llvm-project/commit/282798fefdafc2c86bcc70c66d764d6b09fc6cb9.diff

LOG: [libc] Fix typos in documentation

Added: 
    

Modified: 
    libc/docs/compiler_support.rst
    libc/docs/dev/clang_tidy_checks.rst
    libc/docs/dev/cmake_build_rules.rst
    libc/docs/dev/implementation_standard.rst

Removed: 
    


################################################################################
diff  --git a/libc/docs/compiler_support.rst b/libc/docs/compiler_support.rst
index bdb5620802a43..00234c22dc2e6 100644
--- a/libc/docs/compiler_support.rst
+++ b/libc/docs/compiler_support.rst
@@ -5,7 +5,7 @@ Compiler Support
 ================
 
 ``LLVM libc`` compiles from both ``Clang`` and ``GCC`` but for maximum
-performance we recommand using ``Clang``.
+performance we recommend using ``Clang``.
 
 Indeed, some memory function implementations rely on `compiler intrinsics`__
 that are not currently available in ``GCC``.

diff  --git a/libc/docs/dev/clang_tidy_checks.rst b/libc/docs/dev/clang_tidy_checks.rst
index 67ab5fc65c902..e635f84a5a1a4 100644
--- a/libc/docs/dev/clang_tidy_checks.rst
+++ b/libc/docs/dev/clang_tidy_checks.rst
@@ -30,7 +30,7 @@ implementation-in-namespace
 ---------------------------
 
 It is part of our implementation standards that all implementation pieces live
-under the ``__llvm_libc`` namespace. This prevents polution of the global
+under the ``__llvm_libc`` namespace. This prevents pollution of the global
 namespace. Without a formal check to ensure this, an implementation might
 compile and pass unit tests, but not produce a usable libc function.
 

diff  --git a/libc/docs/dev/cmake_build_rules.rst b/libc/docs/dev/cmake_build_rules.rst
index dfa9f7a6d7d41..2248ff40da237 100644
--- a/libc/docs/dev/cmake_build_rules.rst
+++ b/libc/docs/dev/cmake_build_rules.rst
@@ -6,7 +6,7 @@ The libc CMake build system
 
 At the cost of verbosity, we want to keep the build system of LLVM libc
 as simple as possible. We also want to be highly modular with our build
-targets. This makes picking and choosing desired pieces a straighforward
+targets. This makes picking and choosing desired pieces a straightforward
 task.
 
 Targets for entrypoints

diff  --git a/libc/docs/dev/implementation_standard.rst b/libc/docs/dev/implementation_standard.rst
index 87cee06adf2ee..0fdbb7c3c3d74 100644
--- a/libc/docs/dev/implementation_standard.rst
+++ b/libc/docs/dev/implementation_standard.rst
@@ -15,7 +15,7 @@ tested independent of each other and hence will live in a directory named
 the directory of its own named ``src/math/round/``.
 
 Implementation of entrypoints can span multiple ``.cpp`` and ``.h`` files, but
-there will be atleast one header file with name of the form
+there will be at least one header file with name of the form
 ``<entrypoint name>.h`` for every entrypoint. This header file is called as the
 implementation header file. For the ``round`` function, the path to the
 implementation header file will be ``src/math/round/round.h``. The rest of this


        


More information about the libc-commits mailing list