[LangRef] Minor editorial fixes #137782
[LangRef] Minor editorial fixes #137782
Conversation
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
|
@llvm/pr-subscribers-llvm-ir Author: Kip Hamiltons (KipHamiltons) ChangesFull diff: https://github.com/llvm/llvm-project/pull/137782.diff 1 Files Affected:
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index a5df82895d839..6c65339d92b34 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -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
null byte).
To represent a ``"`` character, use ``\22``. (``\"`` will end the string
@@ -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
+ (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
@@ -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
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.
|
| @@ -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 | |||
There was a problem hiding this comment.
The current rendering is incorrect.
| 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 |
There was a problem hiding this comment.
Just defining TLS. The rest is fixing line widths.
| @@ -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 | |||
There was a problem hiding this comment.
We should be able to read this sentence without the parenthesised words, but we can't without adding for.
|
@KipHamiltons Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
No description provided.