From: James Henderson Date: Mon, 8 Jul 2019 11:41:54 +0000 (+0000) Subject: [docs][llvm-objcopy] Add description of binary input/output to doc X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=dd9df6f533df19c7cf7db073409953c85f0c7ba3;p=llvm [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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@365312 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/CommandGuide/llvm-objcopy.rst b/docs/CommandGuide/llvm-objcopy.rst index bccdccd24f2..e113a82b6ee 100644 --- a/docs/CommandGuide/llvm-objcopy.rst +++ b/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__start``, ``_binary__end``, and +``_binary__size`` representing the start, end and size of the data, +where ```` 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 -----------