[llvm-install-name-tool] Adds docs for install-name-tool

[sameerarora101]

Summary

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

[sameerarora101]

[Ktwu]

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

15

nit: maipulate -> manipulate

18

"it works as a drop-in replacement for Apple's install_name_tool"

Is that a common thing for LLVM tools to talk about in descriptions? It seems weird.

23

"some options can be combined with other options".

There are only two options here. How about being specific and expanding on this later?

29

Does install-name-tool throw different error codes for different error situations? It might be good to document what those error codes are.

[sameerarora101]

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

15

Oops! sorry about that. I'll fix it.

18

So I took inspiration for this from llvm-objcopy's documentation. There is specifies: "The tool is still in active development, but in most scenarios it works as a drop-in replacement for GNU’s objcopy."

23

yup, when I create diffs for -rpath, -id and -change options for install-name, I plan to update this doc as well reflecting the appropriate behavior.

29

it does throw different error "messages" based on different error situations. But i'll take a look if there is a difference in error codes and update it soon.

[sameerarora101]

Adding exit status and bug report info

[sameerarora101]

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

29

install-name-tool has exit code 1 for all the errors. I have now updated that in the EXIT STATUS section below.

[sameerarora101]

Updating exit status

[sameerarora101]

This comment was removed by sameerarora101.

[smeenai]

LGTM, although it needs to be updated with all the other options now :) (I'm good doing that in a follow-up diff.)

llvm/docs/CommandGuide/index.rst

 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. toctree::
    :maxdepth: 1
 
    llvm-addr2line
    llvm-ar
    llvm-cxxfilt
+   llvm-install-name-tool
    llvm-nm
    llvm-objcopy
    llvm-objdump
    llvm-ranlib
    llvm-readelf
    llvm-size
    llvm-strings
    llvm-strip

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

+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 manipulate 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.
+
+EXIT STATUS
+-----------
+
+:program:`llvm-install-name-tool` exits with a non-zero exit code of 1 if there is an error.
+Otherwise, it exits with code 0.
+
+BUGS
+----
+
+To report bugs, please visit <https://bugs.llvm.org/>.
+
+SEE ALSO
+--------
+
+:manpage:`llvm-objcopy(1)`