[lld] [lld][docs] Document two linker-script related options for lld ELF (PR #166313)

[via llvm-commits]

llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-lld-elf

Author: Mingming Liu (mingmingl-llvm)

<details>
<summary>Changes</summary>

This is a follow up of the discussions in https://github.com/llvm/llvm-project/pull/163497

---
Full diff: https://github.com/llvm/llvm-project/pull/166313.diff


1 Files Affected:

- (modified) lld/docs/ELF/linker_script.rst (+19) 


``````````diff
diff --git a/lld/docs/ELF/linker_script.rst b/lld/docs/ELF/linker_script.rst
index c9cb47fc0553e..2946e0156583e 100644
--- a/lld/docs/ELF/linker_script.rst
+++ b/lld/docs/ELF/linker_script.rst
@@ -17,6 +17,25 @@ possible. We reserve the right to make different implementation choices where
 it is appropriate for LLD. Intentional deviations will be documented in this
 file.
 
+Linker Script Specification
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There are two lld options related to setting the linker script,
+`--script=<file>` and `--default-script=<file>`. The usage are illustrated below.
+
+::
+
+  # This sets `--script=<file>` option under the hood.
+  lld -T linker_script.lds
+
+  # This sets `--default-script=<file>` option under the hood.
+  lld -dT linker_script.lds
+
+When both options are given, `--script=<file>` takes precedence.
+The intended use case of `--default-script` is to be used by toolchain
+configurations, and users can override the script by specifying `--script` if
+needed.
+
 Symbol assignment
 ~~~~~~~~~~~~~~~~~
 

``````````

</details>


https://github.com/llvm/llvm-project/pull/166313