[PATCH] D85655: [llvm-install-name-tool] Add more documentation

[Sameer Arora via Phabricator via llvm-commits]

sameerarora101 created this revision.
sameerarora101 added reviewers: jhenderson, MaskRay, alexshap, Ktwu, smeenai.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.
sameerarora101 requested review of this revision.

Add documentation for the remaining options of
`llvm-install-name-tool`.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D85655

Files:
  llvm/docs/CommandGuide/llvm-install-name-tool.rst


Index: llvm/docs/CommandGuide/llvm-install-name-tool.rst
===================================================================
--- llvm/docs/CommandGuide/llvm-install-name-tool.rst
+++ llvm/docs/CommandGuide/llvm-install-name-tool.rst
@@ -22,22 +22,46 @@
 At least one of the following options are required, and some options can be
 combined with other options:
 
+    - Can combine :option:`-add_rpath`, :option:`-delete_rpath` and :option:`-rpath`
+      in an invocation only if they do not share the same `<rpath>` value.
+
 .. option:: -add_rpath <rpath>
 
  Add an rpath named ``<rpath>`` to the specified binary. Can be specified multiple
  times to add multiple rpaths. Throws an error if ``<rpath>`` is already listed in
  the binary.
 
+.. option:: -change <old_install_name> <new_install_name>
+
+ Change an install name ``<old_install_name>`` to ``<new_install_name>`` in the
+ specified binary. Can be specified multiple times to change multiple dependent shared
+ library install names. Option is ignored if ``<old_install_name>`` is not listed
+ in the specfied binary.
+
 .. option:: -delete_rpath <rpath>
 
  Delete an rpath named ``<rpath>`` from the specified binary. Can be specified multiple
  times to delete multiple rpaths. Throws an error if ``<rpath>`` is not listed in
  the binary.
 
+.. option:: -id <name>
+
+ Change shared library's identification name under LC_ID_DYLIB to ``<name>`` in the
+ specfied binary. If specified multiple times, only the last :option:`-id` option is
+ selected. Option is ignored if the specified Mach-O binary is not a dynamic shared library.
+
+.. option:: -rpath <old_rpath> <new_rpath>
+
+ Change an rpath named ``<old_rpath>`` to ``<new_rpath>`` in the specified binary. Can be specified
+ multiple times to change multiple rpaths. Throws an error if ``<old_rpath>`` is not listed
+ in the binary or ``<new_rpath>`` is already listed in the binary.
+
+
+
 EXIT STATUS
 -----------
 
-:program:`llvm-install-name-tool` exits with a non-zero exit code of 1 if there is an error.
+:program:`llvm-install-name-tool` exits with a non-zero exit code if there is an error.
 Otherwise, it exits with code 0.
 
 BUGS


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D85655.284379.patch
Type: text/x-patch
Size: 2170 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200810/03167a9b/attachment.bin>