Skip to content

[LangRef] Minor editorial fixes #137782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 30, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions llvm/docs/LangRef.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ There are two kinds of escapes.
* ``\\`` represents a single ``\`` character.

* ``\`` followed by two hexadecimal characters (0-9, a-f, or A-F)
represents the byte with the given value (e.g. \x00 represents a
represents the byte with the given value (e.g. ``\00`` represents a
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Screenshot 2025-04-29 at 8 32 29 PM

The current rendering is incorrect.

null byte).

To represent a ``"`` character, use ``\22``. (``\"`` will end the string
Expand Down Expand Up @@ -465,11 +465,11 @@ added in the future:
Non-general purpose registers still follow the standard c calling
convention. Currently it is for x86_64 and AArch64 only.
"``cxx_fast_tlscc``" - The `CXX_FAST_TLS` calling convention for access functions
Clang generates an access function to access C++-style TLS. The access
function generally has an entry block, an exit block and an initialization
block that is run at the first time. The entry and exit blocks can access
a few TLS IR variables, each access will be lowered to a platform-specific
sequence.
Clang generates an access function to access C++-style Thread Local Storage
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just defining TLS. The rest is fixing line widths.

(TLS). The access function generally has an entry block, an exit block and an
initialization block that is run at the first time. The entry and exit blocks
can access a few TLS IR variables, each access will be lowered to a
platform-specific sequence.

This calling convention aims to minimize overhead in the caller by
preserving as many registers as possible (all the registers that are
Expand Down Expand Up @@ -727,7 +727,7 @@ optimizations based on the 'constantness' are valid for the translation
units that do not include the definition.

As SSA values, global variables define pointer values that are in scope
(i.e. they dominate) all basic blocks in the program. Global variables
for (i.e. they dominate) all basic blocks in the program. Global variables
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We should be able to read this sentence without the parenthesised words, but we can't without adding for.

always define a pointer to their "content" type because they describe a
region of memory, and all :ref:`allocated object<allocatedobjects>` in LLVM are
accessed through pointers.
Expand Down
Loading