Re: [Qemu-devel] [PATCH v5 3/3] docs: Add a generic loader explanation document

[Alistair Francis]

On Thu, May 12, 2016 at 9:24 AM, Eric Blake <address@hidden> wrote:
> On 05/12/2016 10:13 AM, Alistair Francis wrote:
>> Signed-off-by: Alistair Francis <address@hidden>
>> ---
>> V4:
>>  - Re-write to be more comprehensive
>>
>>  docs/generic-loader.txt | 56 
>> +++++++++++++++++++++++++++++++++++++++++++++++++
>>  1 file changed, 56 insertions(+)
>>  create mode 100644 docs/generic-loader.txt
>
>> +Loading Memory Values
>> +---------------------------
>
> Worth matching ---- line length to the line above?

Good point, fixed.

>
>> +
>> +NOTE: The loader device supports other options (see the next section) but 
>> they
>> +      do not apply to setting memory values and will be ignored.
>
> Ignoring invalid option combinations is not as friendly as outright
> rejecting them.

Ok, I have added stricter checking to cover most invalid use cases.

>
>
>> +
>> +Loading Files
>> +---------------------------
>
> And again

Fixed.

>
>> +The loader device also allows files to be loaded into memory. This can be 
>> done
>> +similarly to setting memory values. The syntax is shown below:
>> +
>> +    -device loader,file=<file>,addr=<addr>,cpu-num=<cpu-num>,force-raw=<raw>
>> +
>> +    <file>      - A file to be loaded into memory
>> +    <addr>      - The addr in memory that the file should be loaded. This is
>> +                  ignored if you are using an ELF (unless force-raw is 
>> true).
>> +                  This is requried if you aren't loading an ELF.
>
> s/requried/required/

Fixed

>
>> +    <cpu-num>   - This specifices the CPU that should be used. This is an
>
> s/specifices/specifies/

Fixed

>
>> +                  optional argument and will cause the CPU's PC to be set to
>> +                  where the image is stored. This option should only be used
>> +                  for the boot image.
>> +    <force-raw> - Forces the file to be treated as a raw image. This can be
>> +                  used to specificy the load address of ELF files.
>
> s/specificy/specify/

Fixed.

Thanks for reading the patch.

Alistair

>
>> +
>> +An example of loading an ELF file which CPU0 will boot is shown below:
>> +    -device loader,file=./images/boot.elf,cpu-num=0
>>
>
> --
> Eric Blake   eblake redhat com    +1-919-301-3266
> Libvirt virtualization library http://libvirt.org
>