[PATCH] D75921: [LLD][DOCS][ELF]Add initial LLD LinkerScript docs page

[Peter Smith via Phabricator via llvm-commits]

psmith created this revision.
psmith added reviewers: MaskRay, grimar, ruiu.
Herald added subscribers: arphaman, emaste.
Herald added a reviewer: espindola.
Herald added a project: LLVM.

LLD implements Linker Scripts as they are described in the GNU ld manual. This description is far from a specification, with the only true reference the GNU ld implementation, which has undocumented behaviour that can vary from release to release. To make it easy for people to switch between linkers we try to follow GNU ld implementation details wherever possible. We reserve the right to make our own decisions where the undocumented GNU ld behaviour is not appropriate for LLD. We don't have a place to document these decisions and it can be difficult for users to find out this information.

      

This file is a statement of the LLD linker script implementation policy and will contain intentional deviations from GNU ld. The first patch that will add concrete details to this file is D75724 <https://reviews.llvm.org/D75724>


https://reviews.llvm.org/D75921

Files:
  lld/docs/ELF/linker_script.rst
  lld/docs/index.rst


Index: lld/docs/index.rst
===================================================================
--- lld/docs/index.rst
+++ lld/docs/index.rst
@@ -176,3 +176,4 @@
    missingkeyfunction
    Partitions
    ReleaseNotes
+   ELF/linker_script
Index: lld/docs/ELF/linker_script.rst
===================================================================
--- /dev/null
+++ lld/docs/ELF/linker_script.rst
@@ -0,0 +1,18 @@
+Linker Script implementation notes and policy
+=============================================
+
+LLD implements a large subset of the GNU ld linker script notation. The LLD
+implementation policy is to implement linker script features as they are
+documented in the ld `manual https://sourceware.org/binutils/docs/ld/Scripts.html`
+We consider it a bug if the lld implementation does not agree with the manual
+and it is not mentioned in the exceptions below.
+
+The ld manual is not a complete specification, and is not sufficient to build
+an implementation. In particular some features are only defined by the
+implementation and have changed over time.
+
+The lld implementation policy for properties of linker scripts that are not
+defined by the documentation is to follow the GNU ld implementation wherever
+possible. We reserve the right to make different implementation choices where
+it is appropriate for LLD. Intentional deviations will be documented in this
+file.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D75921.249364.patch
Type: text/x-patch
Size: 1387 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200310/45a81cc2/attachment.bin>