summaryrefslogtreecommitdiffstats
path: root/llvm/docs/CommandGuide
diff options
context:
space:
mode:
authorJames Henderson <jh7370@my.bristol.ac.uk>2019-07-08 11:41:54 +0000
committerJames Henderson <jh7370@my.bristol.ac.uk>2019-07-08 11:41:54 +0000
commit8cf99a1170483287729190c839aad3526f1b9c11 (patch)
tree4e4300a6ace4735d020e11a24a0884853d7fe648 /llvm/docs/CommandGuide
parent674d8a947c7fc323dde9dc16d22667ce30169ee7 (diff)
downloadbcm5719-llvm-8cf99a1170483287729190c839aad3526f1b9c11.tar.gz
bcm5719-llvm-8cf99a1170483287729190c839aad3526f1b9c11.zip
[docs][llvm-objcopy] Add description of binary input/output to doc
We briefly referred to being able to specify --target=binary without explaining what binary input/output meant. This change adds a section on this. Reviewed by: MaskRay, abrachet Differential Revision: https://reviews.llvm.org/D64245 llvm-svn: 365312
Diffstat (limited to 'llvm/docs/CommandGuide')
-rw-r--r--llvm/docs/CommandGuide/llvm-objcopy.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/llvm/docs/CommandGuide/llvm-objcopy.rst b/llvm/docs/CommandGuide/llvm-objcopy.rst
index bccdccd24f2..e113a82b6ee 100644
--- a/llvm/docs/CommandGuide/llvm-objcopy.rst
+++ b/llvm/docs/CommandGuide/llvm-objcopy.rst
@@ -457,8 +457,23 @@ options. For GNU :program:`objcopy` compatibility, the values are all bfdnames.
- `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
-----------
OpenPOWER on IntegriCloud