This is an archive of the discontinued LLVM Phabricator instance.

Differential D122907

[llvm-objcopy][docs] Add --update-section to objcopy command guide
ClosedPublic

Authored by gbreynoo on Apr 1 2022, 7:59 AM.

Details

Reviewers
MaskRay
leonardchan
jhenderson
alexander-shaposhnikov
rupprecht
Commits
rG3ad6f535024c: [llvm-objcopy][docs] Update --update-section description
Summary

I noticed that when --update-section was added to llvm-objcopy it was not added to the command guide, see 25bcd94234530955c58c6530a9271c813827637c. This change adds it to the docs.

Diff Detail

Unit TestsFailed

TimeTest
60,080 msx64 debian > AddressSanitizer-x86_64-linux.TestCases::scariness_score_test.cpp
60,040 msx64 debian > MLIR.Examples/standalone::test.toy
60,030 msx64 debian > libFuzzer.libFuzzer::large.test

Event Timeline

gbreynoo created this revision.Apr 1 2022, 7:59 AM
Herald added a reviewer: alexander-shaposhnikov. · View Herald TranscriptApr 1 2022, 7:59 AM
Herald added a project: Restricted Project. · View Herald Transcript
Herald added subscribers: StephenFan, abrachet. · View Herald Transcript
gbreynoo requested review of this revision.Apr 1 2022, 7:59 AM
Herald added a project: Restricted Project. · View Herald TranscriptApr 1 2022, 7:59 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
MaskRay accepted this revision.Apr 1 2022, 8:29 AM
This revision is now accepted and ready to land.Apr 1 2022, 8:29 AM
abrachet added inline comments.Apr 1 2022, 8:31 AM
llvm/docs/CommandGuide/llvm-objcopy.rst
222

I don't think --update-section will add a section if it doesn't exist. It just updates the contents of an existing section. Might also be worth mentioning that it must be the same size or smaller.

Harbormaster completed remote builds in B157419: Diff 419758.Apr 1 2022, 8:44 AM
gbreynoo updated this revision to Diff 419782.Apr 1 2022, 9:16 AM

Fixed the description after abrachet's comment and updated the help output to mirror the change.

Herald added a reviewer: rupprecht. · View Herald TranscriptApr 1 2022, 9:16 AM
gbreynoo added inline comments.Apr 1 2022, 9:17 AM
llvm/docs/CommandGuide/llvm-objcopy.rst
222

Good catch @abrachet, I've updated the description.

Harbormaster completed remote builds in B157435: Diff 419782.Apr 1 2022, 10:05 AM
jhenderson accepted this revision.Apr 4 2022, 12:37 AM

LGTM, but mention the help text fix in the commit message too, please.

This revision was landed with ongoing or failed builds.Apr 4 2022, 8:23 AM
Closed by commit rG3ad6f535024c: [llvm-objcopy][docs] Update --update-section description (authored by gbreynoo). · Explain Why
This revision was automatically updated to reflect the committed changes.
gbreynoo added a commit: rG3ad6f535024c: [llvm-objcopy][docs] Update --update-section description.

Revision Contents

PathSize
llvm/
docs/
CommandGuide/
6 lines
tools/
llvm-objcopy/
2 lines

Diff 419782

llvm/docs/CommandGuide/llvm-objcopy.rst

Show First 20 Lines • Show All 211 Lines • ▼ Show 20 Lines
trailing whitespace ignored, as is anything following a '#'. Can be specified trailing whitespace ignored, as is anything following a '#'. Can be specified
multiple times to read names from multiple files. multiple times to read names from multiple files.
.. option:: --strip-unneeded .. option:: --strip-unneeded
Remove from the output all local or undefined symbols that are not required by Remove from the output all local or undefined symbols that are not required by
relocations. Also remove all debug sections. relocations. Also remove all debug sections.
.. option:: --update-section <name>=<file>
Replace the contents of the section ``<name>`` with contents from the file
abrachetUnsubmitted
Not Done
ReplyInline Actions

I don't think --update-section will add a section if it doesn't exist. It just updates the contents of an existing section. Might also be worth mentioning that it must be the same size or smaller.

abrachet: I don't think `--update-section` will add a section if it doesn't exist. It just updates the…
gbreynooAuthorUnsubmitted
Done
ReplyInline Actions

Good catch @abrachet, I've updated the description.

gbreynoo: Good catch @abrachet, I've updated the description.
``<file>``. If the section ``<name>`` is part of a segment, the new contents
cannot be larger than the existing section.
.. option:: --version, -V .. option:: --version, -V
Display the version of the :program:`llvm-objcopy` executable. Display the version of the :program:`llvm-objcopy` executable.
.. option:: --wildcard, -w .. option:: --wildcard, -w
Allow wildcard syntax for symbol-related flags. On by default for Allow wildcard syntax for symbol-related flags. On by default for
section-related flags. Incompatible with --regex. section-related flags. Incompatible with --regex.
▲ Show 20 Lines • Show All 329 Lines • Show Last 20 Lines

llvm/tools/llvm-objcopy/ObjcopyOpts.td

Show First 20 Lines • Show All 216 Lines • ▼ Show 20 Linesdefm add_symbol
: Eq<"add-symbol", "Add new symbol <name> to .symtab. Accepted flags: " : Eq<"add-symbol", "Add new symbol <name> to .symtab. Accepted flags: "
"global, local, weak, default, hidden, protected, file, section, object, " "global, local, weak, default, hidden, protected, file, section, object, "
"function, indirect-function. Accepted but ignored for " "function, indirect-function. Accepted but ignored for "
"compatibility: debug, constructor, warning, indirect, synthetic, " "compatibility: debug, constructor, warning, indirect, synthetic, "
"unique-object, before.">, "unique-object, before.">,
MetaVarName<"name=[section:]value[,flags]">; MetaVarName<"name=[section:]value[,flags]">;
defm update_section defm update_section
: Eq<"update-section", "Add section <name> with contents from a file <file>.">, : Eq<"update-section", "Replace the contents of section <name> with contents from a file <file>.">,
MetaVarName<"name=file">; MetaVarName<"name=file">;