Skip to content

Commit

Permalink
[libc] Fix typos in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kazutakahirata committed May 6, 2023
1 parent ee05479 commit 282798f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion libc/docs/compiler_support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/dev/clang_tidy_checks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion libc/docs/dev/cmake_build_rules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion libc/docs/dev/implementation_standard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

1 comment on commit 282798f

@michaelrj-google
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fixes!

Please sign in to comment.