This is an archive of the discontinued LLVM Phabricator instance.

Differential D64245

[docs][llvm-objcopy] Add description of binary input/output to doc
ClosedPublic

Authored by jhenderson on Jul 5 2019, 5:45 AM.

Details

Reviewers
jakehehrlich
rupprecht
MaskRay
abrachet
alexander-shaposhnikov
Commits
rG8cf99a117048: [docs][llvm-objcopy] Add description of binary input/output to doc
rL365312: [docs][llvm-objcopy] Add description of binary input/output to doc
Summary

We briefly referred to being able to specify --target=binary without explaining what binary input/output meant. This change adds a section on this.

Diff Detail

Repository
rL LLVM

Event Timeline

jhenderson created this revision.Jul 5 2019, 5:45 AM
Herald added a reviewer: alexander-shaposhnikov. · View Herald TranscriptJul 5 2019, 5:45 AM
Herald added a project: Restricted Project. · View Herald Transcript
abrachet accepted this revision.Jul 5 2019, 8:27 PM

LGTM

docs/CommandGuide/llvm-objcopy.rst
466

This is super nit, and I'm not sure if either way is correct. But it seems like known option arguments use one back tick and then the user specified flags like <filename> use two. See --add-symbol on line 170 and --compress-debug-sections on line 221. If we follow those then 'binary' should only be with single back ticks. Of course line 460 uses the double back ticks though. I don't think it makes a huge difference either way just thought I would bring this up.

This revision is now accepted and ready to land.Jul 5 2019, 8:27 PM
MaskRay accepted this revision.Jul 6 2019, 1:19 AM
jhenderson marked an inline comment as done.Jul 8 2019, 3:10 AM
jhenderson added inline comments.
docs/CommandGuide/llvm-objcopy.rst
466

The difference is in rendering. Double back-tick makes it monospace, whilst single back-tick makes it italicised (and possibly monospace, though it's harder to tell). Looking back at what I did previously, it looks like I used single back ticks for valid values everywhere, so it probably makes sense to update here and line 460 before committing. Thanks!

Closed by commit rL365312: [docs][llvm-objcopy] Add description of binary input/output to doc (authored by jhenderson). · Explain WhyJul 8 2019, 4:44 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
docs/
CommandGuide/
15 lines

Diff 208162

docs/CommandGuide/llvm-objcopy.rst

Show First 20 Lines • Show All 454 Lines • ▼ Show 20 Lines
- `elf64-tradbigmips` - `elf64-tradbigmips`
- `elf64-tradlittlemips` - `elf64-tradlittlemips`
- `elf32-sparc` - `elf32-sparc`
- `elf32-sparcel` - `elf32-sparcel`
Additionally, all targets except ``binary`` and ``ihex`` can have ``-freebsd`` Additionally, all targets except ``binary`` and ``ihex`` can have ``-freebsd``
as a suffix. as a suffix.
BINARY INPUT AND OUTPUT
-----------------------
If ``binary`` is used as the value for :option:`--input-target`, the input file
abrachetUnsubmitted
Not Done
ReplyInline Actions

This is super nit, and I'm not sure if either way is correct. But it seems like known option arguments use one back tick and then the user specified flags like <filename> use two. See --add-symbol on line 170 and --compress-debug-sections on line 221. If we follow those then 'binary' should only be with single back ticks. Of course line 460 uses the double back ticks though. I don't think it makes a huge difference either way just thought I would bring this up.

abrachet: This is super nit, and I'm not sure if either way is correct. But it seems like known option…
jhendersonAuthorUnsubmitted
Done
ReplyInline Actions

The difference is in rendering. Double back-tick makes it monospace, whilst single back-tick makes it italicised (and possibly monospace, though it's harder to tell). Looking back at what I did previously, it looks like I used single back ticks for valid values everywhere, so it probably makes sense to update here and line 460 before committing. Thanks!

jhenderson: The difference is in rendering. Double back-tick makes it monospace, whilst single back-tick…
will be embedded as a data section in an ELF relocatable object, with symbols
``_binary_<file_name>_start``, ``_binary_<file_name>_end``, and
``_binary_<file_name>_size`` representing the start, end and size of the data,
where ``<file_name>`` is the path of the input file as specified on the command
line with non-alphanumeric characters converted to ``_``.
If ``binary`` is used as the value for :option:`--output-target`, the output
file will be a raw binary file, containing the memory image of the input file.
Symbols and relocation information will be discarded. The image will start at
the address of the first loadable section in the output.
EXIT STATUS EXIT STATUS
----------- -----------
:program:`llvm-objcopy` exits with a non-zero exit code if there is an error. :program:`llvm-objcopy` 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
---- ----
Show All 12 Lines