[PATCH] D155904: [Docs][llvm-link] Add documentation an CLI options

[Aiden Grossman via Phabricator via llvm-commits]

aidengrossman created this revision.
Herald added a project: All.
aidengrossman requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

Currently the documentation on the command line options for llvm-link is quite sparse. This patch adds in the options that the tool understands that aren't currently present in the documentation.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D155904

Files:
  llvm/docs/CommandGuide/llvm-link.rst


Index: llvm/docs/CommandGuide/llvm-link.rst
===================================================================
--- llvm/docs/CommandGuide/llvm-link.rst
+++ llvm/docs/CommandGuide/llvm-link.rst
@@ -49,8 +49,60 @@
  This typically includes a message for each bitcode file linked in and for each
  library found.

+.. option:: -override <filename>
+
+  Adds the passed-in file to the link and overrides symbols that have already
+  been declared with the definitions in the file that is passed in. This flag
+  can be specified multiple times to have multiple files act as overrides. If
+  a symbol is declared more than twice, the definition from the file declared
+  last takes precedence.
+
+.. option:: -import <function:filename>
+
+  Specify a function that should be imported from the specified file for
+  linking with ThinLTO. This option can be specified multiple times to import
+  multiple functions.
+
+.. option:: -summary-index <filename>
+
+  Specify the path to a file containing the module summary index used for
+  doing a ThinLTO link.
+
+.. option:: -internalize
+
+  Internalize the linked symbols.
+
+.. option:: -disable-debug-info-type-map
+
+  Disables the use of a uniquing type map for debug info.
+
+.. option:: -only-needed
+
+  Link only needed symbols.
+
+.. option:: -disable-lazy-loading
+
+  Disable lazy module loading.
+
+.. option:: -suppress-warnings
+
+  Suppress all linker warnings.
+
+.. option:: -preserve-bc-uselistorder
+
+  Preserve the use-list order when writing LLVM bitcode.
+
+.. option:: -preserve-ll-uselistorder
+
+  Preserve the use-list order when writing LLVM assembly.
+
+.. option:: -ignore-non-bitcode
+
+  Do not error out when a non-bitcode file is encountered while processing
+  an archive.
+
 EXIT STATUS
 -----------

 If :program:`llvm-link` succeeds, it will exit with 0.  Otherwise, if an error
 occurs, it will exit with a non-zero value.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D155904.542730.patch
Type: text/x-patch
Size: 1908 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230721/b4411353/attachment.bin>