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

[Sameer Arora via Phabricator via llvm-commits]

sameerarora101 marked 5 inline comments as done.
sameerarora101 added inline comments.


================
Comment at: llvm/docs/CommandGuide/llvm-install-name-tool.rst:14
+
+:program:`llvm-install-name-tool` is a tool to maipulate dynamic shared library
+install names and rpaths listed in a Mach-O binary.
----------------
Ktwu wrote:
> nit: maipulate -> manipulate
Oops! sorry about that. I'll fix it.


================
Comment at: llvm/docs/CommandGuide/llvm-install-name-tool.rst:17
+
+For most scenarios, it works as a drop-in replacement for Apple's
+:program:`install_name_tool`.
----------------
Ktwu wrote:
> "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.
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."


================
Comment at: llvm/docs/CommandGuide/llvm-install-name-tool.rst:22
+--------
+At least one of the following options are required, and some options can be
+combined with other options:
----------------
Ktwu wrote:
> "some options can be combined with other options".
> 
> There are only two options here. How about being specific and expanding on this later?
> 
> 
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. 


================
Comment at: llvm/docs/CommandGuide/llvm-install-name-tool.rst:28
+ 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.
----------------
Ktwu wrote:
> Does `install-name-tool` throw different error codes for different error situations? It might be good to document what those error codes are.
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.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D81944