[llvm] 612b4dd - [llvm-install-name-tool] Add more documentation

[Sameer Arora via llvm-commits]

Author: Sameer Arora
Date: 2020-08-13T10:47:47-07:00
New Revision: 612b4dda7667284f81eec0d3447356e88a87f350

URL: https://github.com/llvm/llvm-project/commit/612b4dda7667284f81eec0d3447356e88a87f350
DIFF: https://github.com/llvm/llvm-project/commit/612b4dda7667284f81eec0d3447356e88a87f350.diff

LOG: [llvm-install-name-tool] Add more documentation

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

Reviewed by jhenderson, smeenai

Differential Revision: https://reviews.llvm.org/D85655

Added: 
    

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

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/llvm-install-name-tool.rst b/llvm/docs/CommandGuide/llvm-install-name-tool.rst
index 5fa1233721db..da258afbaee8 100644
--- a/llvm/docs/CommandGuide/llvm-install-name-tool.rst
+++ b/llvm/docs/CommandGuide/llvm-install-name-tool.rst
@@ -20,7 +20,9 @@ For most scenarios, it works as a drop-in replacement for Apple's
 OPTIONS
 --------
 At least one of the following options are required, and some options can be
-combined with other options:
+combined with other options. Options :option:`-add_rpath`, :option:`-delete_rpath`,
+and :option:`-rpath` can be combined in an invocation only if they do not share
+the same `<rpath>` value.
 
 .. option:: -add_rpath <rpath>
 
@@ -28,16 +30,35 @@ combined with other options:
  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