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

[Aiden Grossman via Phabricator via llvm-commits]

aidengrossman updated this revision to Diff 547417.
aidengrossman marked 2 inline comments as done.
aidengrossman added a comment.

Address reviewer feedback.

- Update message for --summary-index
- Use double dash long messages


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D155904/new/

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
@@ -39,18 +39,71 @@
  If specified, :program:`llvm-link` prints a human-readable version of the
  output bitcode file to standard error.

-.. option:: -help
+.. option:: --help

  Print a summary of command line options.

 .. option:: -v

  Verbose mode.  Print information about what :program:`llvm-link` is doing.
  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 with the
+  results of an earlier ThinLTO link. This option is required when
+  `--import` is used.
+
+.. 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.547417.patch
Type: text/x-patch
Size: 2282 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230805/91eb844a/attachment.bin>