This is an archive of the discontinued LLVM Phabricator instance.

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

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

Details

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 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!

This revision was automatically updated to reflect the committed changes.