[llvm] r323839 - docs: wordsmith some of the linker option extension

Saleem Abdulrasool via llvm-commits llvm-commits at lists.llvm.org
Tue Jan 30 16:16:23 PST 2018


Author: compnerd
Date: Tue Jan 30 16:16:23 2018
New Revision: 323839

URL: http://llvm.org/viewvc/llvm-project?rev=323839&view=rev
Log:
docs: wordsmith some of the linker option extension

Apply the grammatical improvements suggested by Rafael Avila de
Espindola in post-commit review.

Modified:
    llvm/trunk/docs/Extensions.rst

Modified: llvm/trunk/docs/Extensions.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/Extensions.rst?rev=323839&r1=323838&r2=323839&view=diff
==============================================================================
--- llvm/trunk/docs/Extensions.rst (original)
+++ llvm/trunk/docs/Extensions.rst Tue Jan 30 16:16:23 2018
@@ -228,13 +228,13 @@ In order to support passing linker optio
 special section of type ``SHT_LLVM_LINKER_OPTIONS`` (usually named
 ``.linker-options`` though the name is not significant as it is identified by
 the type).  The contents of this section is a simple pair-wise encoding of
-options for consideration by the linker.  The strings are encoded as standard
+directives for consideration by the linker.  The strings are encoded as standard
 null-terminated UTF-8 strings.  They are emitted inline to avoid having the
-linker to traverse the object file for retrieving the value.  The linker is
+linker traverse the object file for retrieving the value.  The linker is
 permitted to not honour the option and instead provide a warning/error to the
 user that the requested option was not honoured.
 
-The section is marked as ``SHT_LLVM_LINKER_OPTIONS`` and has the ``SHF_EXCLUDE``
+The section has type ``SHT_LLVM_LINKER_OPTIONS`` and has the ``SHF_EXCLUDE``
 flag to ensure that the section is treated as opaque by linkers which do not
 support the feature and will not be emitted into the final linked binary.
 
@@ -248,7 +248,8 @@ This would be equivalent to the follow r
   .asciz "option 2"
   .asciz "value 2"
 
-LLVM emits the following options:
+The following directives are specified:
+
   - lib
 
     The parameter identifies a library to be linked against.  The library will




More information about the llvm-commits mailing list