[PATCH] D81944: [llvm-install-name-tool] Adds docs for install-name-tool
Kellie Medlin via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Tue Jun 16 11:00:13 PDT 2020
Ktwu 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.
----------------
nit: maipulate -> manipulate
================
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`.
----------------
"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.
================
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:
----------------
"some options can be combined with other options".
There are only two options here. How about being specific and expanding on this later?
================
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.
----------------
Does `install-name-tool` throw different error codes for different error situations? It might be good to document what those error codes are.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D81944/new/
https://reviews.llvm.org/D81944
More information about the llvm-commits
mailing list