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

[James Henderson via Phabricator via llvm-commits]

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

Changed prior to commit:
  https://reviews.llvm.org/D64245?vs=208162&id=208367#toc

Repository:
  rL LLVM

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

https://reviews.llvm.org/D64245

Files:
  llvm/trunk/docs/CommandGuide/llvm-objcopy.rst


Index: llvm/trunk/docs/CommandGuide/llvm-objcopy.rst
===================================================================
--- llvm/trunk/docs/CommandGuide/llvm-objcopy.rst
+++ llvm/trunk/docs/CommandGuide/llvm-objcopy.rst
@@ -457,8 +457,23 @@
 - `elf32-sparc`
 - `elf32-sparcel`
 
-Additionally, all targets except ``binary`` and ``ihex`` can have ``-freebsd``
-as a suffix.
+Additionally, all targets except `binary` and `ihex` can have `-freebsd` as a
+suffix.
+
+BINARY INPUT AND OUTPUT
+-----------------------
+
+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
+``_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
 -----------


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D64245.208367.patch
Type: text/x-patch
Size: 1282 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190708/8ef1d758/attachment.bin>