[PATCH] D64245: [docs][llvm-objcopy] Add description of binary input/output to doc

Mon Jul 8 03:10:30 PDT 2019

jhenderson marked an inline comment as done.
jhenderson added inline comments.

================
Comment at: docs/CommandGuide/llvm-objcopy.rst:466
+
+If ``binary`` is used as the value for :option:`--input-target`, the input file
+will be embedded as a data section in an ELF relocatable object, with symbols
----------------
abrachet wrote:
> 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.
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!

Repository:
  rL LLVM

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64245/new/

https://reviews.llvm.org/D64245