[libcxx-commits] [libcxx] da6a1f6 - [libc] Fix typos in documentation

Kazu Hirata via libcxx-commits libcxx-commits at lists.llvm.org
Mon May 22 23:25:22 PDT 2023


Author: Kazu Hirata
Date: 2023-05-22T23:25:16-07:00
New Revision: da6a1f61d94c05e36d7797b198bc55ac6486f4ff

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

LOG: [libc] Fix typos in documentation

Added: 
    

Modified: 
    libcxx/docs/BuildingLibcxx.rst
    libcxx/docs/DesignDocs/ExtendedCXX03Support.rst
    libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst
    libcxx/docs/ReleaseNotes.rst
    libcxx/docs/TestingLibcxx.rst
    libcxx/docs/UsingLibcxx.rst

Removed: 
    


################################################################################
diff  --git a/libcxx/docs/BuildingLibcxx.rst b/libcxx/docs/BuildingLibcxx.rst
index 59c695efe44e7..3a4e4790631b4 100644
--- a/libcxx/docs/BuildingLibcxx.rst
+++ b/libcxx/docs/BuildingLibcxx.rst
@@ -10,7 +10,7 @@ Building libc++
 .. _build instructions:
 
 The instructions on this page are aimed at vendors who ship libc++ as part of an
-operating system distribution, a toolchain or similar shipping vehicules. If you
+operating system distribution, a toolchain or similar shipping vehicles. If you
 are a user merely trying to use libc++ in your program, you most likely want to
 refer to your vendor's documentation, or to the general documentation for using
 libc++ :ref:`here <using-libcxx>`.

diff  --git a/libcxx/docs/DesignDocs/ExtendedCXX03Support.rst b/libcxx/docs/DesignDocs/ExtendedCXX03Support.rst
index 213cf2dab01e1..8c18e563e8199 100644
--- a/libcxx/docs/DesignDocs/ExtendedCXX03Support.rst
+++ b/libcxx/docs/DesignDocs/ExtendedCXX03Support.rst
@@ -88,10 +88,10 @@ in the function parameter list, and in the return type. For example:
   template <class _Tp>
   enable_if_t</*...*/> baz(_Tp); // # 3
 
-Using default template parameters for SFINAE (#1) should always be prefered.
+Using default template parameters for SFINAE (#1) should always be preferred.
 
 Option #2 has two problems. First, users can observe and accidentally pass values to the SFINAE
-function argument. Second, the default arguement creates a live variable, which causes debug
+function argument. Second, the default argument creates a live variable, which causes debug
 information to be emitted containing the text of the SFINAE.
 
 Option #3 can also cause more debug information to be emitted than is needed, because the function

diff  --git a/libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst b/libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst
index 7e92e27120b5a..70278798ecf63 100644
--- a/libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst
+++ b/libcxx/docs/DesignDocs/UnspecifiedBehaviorRandomization.rst
@@ -17,7 +17,7 @@ Consider the follow snippet which steadily happens in tests:
 
 Under this assumption all elements in the vector whose first elements are equal
 do not guarantee any order. Unfortunately, this prevents libcxx introducing
-other implementatiosn because tests might silently fail and the users might
+other implementations because tests might silently fail and the users might
 heavily depend on the stability of implementations.
 
 Goal

diff  --git a/libcxx/docs/ReleaseNotes.rst b/libcxx/docs/ReleaseNotes.rst
index d712dfdedbea6..70927368c5d61 100644
--- a/libcxx/docs/ReleaseNotes.rst
+++ b/libcxx/docs/ReleaseNotes.rst
@@ -73,12 +73,12 @@ Deprecations and Removals
   - C++2b: ``atomic``, ``bit``, ``cstdint``, ``cstdlib``, ``cstring``, ``initializer_list``, ``limits``, ``new``,
            ``stdexcept``, ``system_error``, ``type_traits``, ``typeinfo``
 
-- ``<algorithm>`` no longer includes ``<chrono>`` in any C++ version (it was prevously included in C++17 and earlier).
+- ``<algorithm>`` no longer includes ``<chrono>`` in any C++ version (it was previously included in C++17 and earlier).
 
-- ``<string>`` no longer includes ``<vector>`` in any C++ version (it was prevously included in C++20 and earlier).
+- ``<string>`` no longer includes ``<vector>`` in any C++ version (it was previously included in C++20 and earlier).
 
 - ``<string>``, ``<string_view>``, and ``<mutex>`` no longer include ``<functional>``
-  in any C++ version (it was prevously included in C++20 and earlier).
+  in any C++ version (it was previously included in C++20 and earlier).
 
 - The headers ``<experimental/algorithm>`` and ``<experimental/functional>`` have been removed, since all the contents
   have been implemented in namespace ``std`` for at least two releases.

diff  --git a/libcxx/docs/TestingLibcxx.rst b/libcxx/docs/TestingLibcxx.rst
index 3d37c990ac1ad..44f3904f4e426 100644
--- a/libcxx/docs/TestingLibcxx.rst
+++ b/libcxx/docs/TestingLibcxx.rst
@@ -319,7 +319,7 @@ concatenate its arguments to a ``std::string`` and write it to ``stderr``. When
 the output can't be concatenated a default message will be written to
 ``stderr``. This is useful for tests where the arguments use 
diff erent
 character types like ``char`` and ``wchar_t``, the latter can't simply be
-written to ``stderrr``.
+written to ``stderr``.
 
 This macro is in a 
diff erent header as ``assert_macros.h`` since it pulls in
 additional headers.

diff  --git a/libcxx/docs/UsingLibcxx.rst b/libcxx/docs/UsingLibcxx.rst
index a7ab788dbc597..3acb07bcc2b5b 100644
--- a/libcxx/docs/UsingLibcxx.rst
+++ b/libcxx/docs/UsingLibcxx.rst
@@ -173,7 +173,7 @@ that this function is provided by the static or shared library, so it is only av
 to a platform where the compiled library is sufficiently recent. On older platforms, the program will
 terminate in an unspecified unsuccessful manner, but the quality of diagnostics won't be great.
 However, users can also override that mechanism at two 
diff erent levels. First, the mechanism can be
-overriden at compile-time by defining the ``_LIBCPP_VERBOSE_ABORT(format, args...)`` variadic macro.
+overridden at compile-time by defining the ``_LIBCPP_VERBOSE_ABORT(format, args...)`` variadic macro.
 When that macro is defined, it will be called with a format string as the first argument, followed by
 a series of arguments to format using printf-style formatting. Compile-time customization may be
 interesting to get precise control over code generation, however it is also inconvenient to use in


        


More information about the libcxx-commits mailing list