This is an archive of the discontinued LLVM Phabricator instance.

Differential D85655

[llvm-install-name-tool] Add more documentation
ClosedPublic

Authored by sameerarora101 on Aug 10 2020, 8:11 AM.

Details

Reviewers
jhenderson
MaskRay
alexander-shaposhnikov
Ktwu
smeenai
Commits
rG612b4dda7667: [llvm-install-name-tool] Add more documentation
Summary

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

Diff Detail

Event Timeline

sameerarora101 created this revision.Aug 10 2020, 8:11 AM
Herald added a project: Restricted Project. · View Herald TranscriptAug 10 2020, 8:11 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
sameerarora101 requested review of this revision.Aug 10 2020, 8:11 AM
sameerarora101 added a comment.Aug 10 2020, 8:13 AM

This is how it would look online:

Harbormaster completed remote builds in B67720: Diff 284379.Aug 10 2020, 8:58 AM
smeenai accepted this revision.Aug 10 2020, 8:00 PM

Looks great, thanks!

llvm/docs/CommandGuide/llvm-install-name-tool.rst
27–28

Grammar nit: I'd prefer "-add_rpath, -delete_rpath, and -rpath can be combined in an invocation only if..."

This revision is now accepted and ready to land.Aug 10 2020, 8:00 PM
jhenderson accepted this revision.Aug 11 2020, 2:47 AM

Mostly looks good.

llvm/docs/CommandGuide/llvm-install-name-tool.rst
27–28

I'm not sure this should be a bullet point. It seems like it should be a new sentence at the end of the previous paragraph.

58–59

Let's get rid of the excessive new lines!

sameerarora101 marked 3 inline comments as done.Aug 11 2020, 7:13 AM
sameerarora101 added inline comments.
llvm/docs/CommandGuide/llvm-install-name-tool.rst
27–28

Added as a sentence. How does that look?

sameerarora101 updated this revision to Diff 284706.Aug 11 2020, 7:15 AM
sameerarora101 marked an inline comment as done.

Remove extra lines.

jhenderson accepted this revision.Aug 11 2020, 7:22 AM
jhenderson added inline comments.
llvm/docs/CommandGuide/llvm-install-name-tool.rst
27–28

Thanks, looks good.

Harbormaster completed remote builds in B67894: Diff 284706.Aug 11 2020, 7:56 AM
sameerarora101 updated this revision to Diff 285402.Aug 13 2020, 9:25 AM

Rebase to remove previous build errors.

Harbormaster completed remote builds in B68287: Diff 285402.Aug 13 2020, 10:32 AM
Closed by commit rG612b4dda7667: [llvm-install-name-tool] Add more documentation (authored by sameerarora101). · Explain WhyAug 13 2020, 10:48 AM
This revision was automatically updated to reflect the committed changes.
sameerarora101 added a commit: rG612b4dda7667: [llvm-install-name-tool] Add more documentation.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
25 lines

Diff 285425

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

Show All 14 Lines
install names and rpaths listed in a Mach-O binary. install names and rpaths listed in a Mach-O binary.
For most scenarios, it works as a drop-in replacement for Apple's For most scenarios, it works as a drop-in replacement for Apple's
:program:`install_name_tool`. :program:`install_name_tool`.
OPTIONS OPTIONS
-------- --------
At least one of the following options are required, and some options can be 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> .. option:: -add_rpath <rpath>
smeenaiUnsubmitted
Done
ReplyInline Actions

Grammar nit: I'd prefer "-add_rpath, -delete_rpath, and -rpath can be combined in an invocation only if..."

smeenai: Grammar nit: I'd prefer "-add_rpath, -delete_rpath, and -rpath can be combined in an invocation…
jhendersonUnsubmitted
Done
ReplyInline Actions

I'm not sure this should be a bullet point. It seems like it should be a new sentence at the end of the previous paragraph.

jhenderson: I'm not sure this should be a bullet point. It seems like it should be a new sentence at the…
sameerarora101AuthorUnsubmitted
Done
ReplyInline Actions

Added as a sentence. How does that look?

sameerarora101: Added as a sentence. How does that look?
jhendersonUnsubmitted
Not Done
ReplyInline Actions

Thanks, looks good.

jhenderson: Thanks, looks good.
Add an rpath named ``<rpath>`` to the specified binary. Can be specified multiple 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 times to add multiple rpaths. Throws an error if ``<rpath>`` is already listed in
the binary. 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> .. option:: -delete_rpath <rpath>
Delete an rpath named ``<rpath>`` from the specified binary. Can be specified multiple 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 times to delete multiple rpaths. Throws an error if ``<rpath>`` is not listed in
the binary. 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 EXIT STATUS
----------- -----------
jhendersonUnsubmitted
Done
ReplyInline Actions

Let's get rid of the excessive new lines!

jhenderson: Let's get rid of the excessive new lines!
: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. Otherwise, it exits with code 0.
BUGS BUGS
---- ----
To report bugs, please visit <https://bugs.llvm.org/>. To report bugs, please visit <https://bugs.llvm.org/>.
SEE ALSO SEE ALSO
-------- --------
:manpage:`llvm-objcopy(1)` :manpage:`llvm-objcopy(1)`