[PATCH] D81944: [llvm-install-name-tool] Adds docs for install-name-tool

[Sameer Arora via Phabricator via llvm-commits]

sameerarora101 created this revision.
sameerarora101 added reviewers: smeenai, mtrent, alexshap, Ktwu.
Herald added subscribers: llvm-commits, arphaman.
Herald added a project: LLVM.
sameerarora101 added a comment.

F12176987: Screen Shot 2020-06-16 at 12.14.28 PM.png <https://reviews.llvm.org/F12176987>


In this diff `llvm-install-name-tool.rst` is added and `index.rst` is
updated.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D81944

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


Index: llvm/docs/CommandGuide/llvm-install-name-tool.rst
===================================================================
--- /dev/null
+++ llvm/docs/CommandGuide/llvm-install-name-tool.rst
@@ -0,0 +1,35 @@
+llvm-install-name-tool - LLVM tool for manipulating install-names and rpaths
+============================================================================
+
+.. program:: llvm-install-name-tool
+
+SYNOPSIS
+--------
+
+:program:`llvm-install-name-tool` [*options*] *input*
+
+DESCRIPTION
+-----------
+
+:program:`llvm-install-name-tool` is a tool to maipulate dynamic shared library
+install names and rpaths listed in a Mach-O binary.
+
+For most scenarios, it works as a drop-in replacement for Apple's
+:program:`install_name_tool`.
+
+OPTIONS
+--------
+At least one of the following options are required, and some options can be
+combined with other options:
+
+.. 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:: -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.
Index: llvm/docs/CommandGuide/index.rst
===================================================================
--- llvm/docs/CommandGuide/index.rst
+++ llvm/docs/CommandGuide/index.rst
@@ -43,6 +43,7 @@
    llvm-addr2line
    llvm-ar
    llvm-cxxfilt
+   llvm-install-name-tool
    llvm-nm
    llvm-objcopy
    llvm-objdump


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D81944.271117.patch
Type: text/x-patch
Size: 1640 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20200616/3fd8f932/attachment-0001.bin>