[Qemu-devel] [PATCH v1 1/1] docs/generic-loader: Add restrictions and ToDos

[Qemu-devel] [PATCH v1 1/1] docs/generic-loader: Add restrictions and ToDos

[Alistair Francis]

Add a list of known restrictions and future work that will fix these
restrictions.

Signed-off-by: Alistair Francis <alistair.francis@xilinx.com>
---

 docs/generic-loader.txt | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/generic-loader.txt b/docs/generic-loader.txt
index 8fcb550..305cbc8 100644
--- a/docs/generic-loader.txt
+++ b/docs/generic-loader.txt
@@ -82,3 +82,10 @@ with a '0x'.
 
 An example of loading an ELF file which CPU0 will boot is shown below:
     -device loader,file=./images/boot.elf,cpu-num=0
+
+Restrictions and ToDos
+---------------------
+ - At the moment it is just assumed that if you specify a cpu-num then you
+   want to set the PC as well. This might not always be the case. In future
+   the internal state 'set_pc' (which exists in the generic loader now) should
+   be exposed to the user so that they can choose if the PC is set or not.
-- 
2.7.4

Re: [Qemu-devel] [PATCH v1 1/1] docs/generic-loader: Add restrictions and ToDos

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 1196 bytes --]

On 10/03/2016 03:18 PM, Alistair Francis wrote:
> Add a list of known restrictions and future work that will fix these
> restrictions.
> 
> Signed-off-by: Alistair Francis <alistair.francis@xilinx.com>
> ---
> 
>  docs/generic-loader.txt | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/docs/generic-loader.txt b/docs/generic-loader.txt
> index 8fcb550..305cbc8 100644
> --- a/docs/generic-loader.txt
> +++ b/docs/generic-loader.txt
> @@ -82,3 +82,10 @@ with a '0x'.
>  
>  An example of loading an ELF file which CPU0 will boot is shown below:
>      -device loader,file=./images/boot.elf,cpu-num=0
> +
> +Restrictions and ToDos
> +---------------------

Might be worth it to have the --- line up with the text above.

> + - At the moment it is just assumed that if you specify a cpu-num then you
> +   want to set the PC as well. This might not always be the case. In future
> +   the internal state 'set_pc' (which exists in the generic loader now) should
> +   be exposed to the user so that they can choose if the PC is set or not.
> 

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]

Re: [Qemu-devel] [PATCH v1 1/1] docs/generic-loader: Add restrictions and ToDos

[Alistair Francis]

On Mon, Oct 3, 2016 at 1:35 PM, Eric Blake <eblake@redhat.com> wrote:
> On 10/03/2016 03:18 PM, Alistair Francis wrote:
>> Add a list of known restrictions and future work that will fix these
>> restrictions.
>>
>> Signed-off-by: Alistair Francis <alistair.francis@xilinx.com>
>> ---
>>
>>  docs/generic-loader.txt | 7 +++++++
>>  1 file changed, 7 insertions(+)
>>
>> diff --git a/docs/generic-loader.txt b/docs/generic-loader.txt
>> index 8fcb550..305cbc8 100644
>> --- a/docs/generic-loader.txt
>> +++ b/docs/generic-loader.txt
>> @@ -82,3 +82,10 @@ with a '0x'.
>>
>>  An example of loading an ELF file which CPU0 will boot is shown below:
>>      -device loader,file=./images/boot.elf,cpu-num=0
>> +
>> +Restrictions and ToDos
>> +---------------------
>
> Might be worth it to have the --- line up with the text above.

It's the same length as all the other --- lines. Should I increase
them all to the same length as the title?

Thanks,

Alistair

>
>> + - At the moment it is just assumed that if you specify a cpu-num then you
>> +   want to set the PC as well. This might not always be the case. In future
>> +   the internal state 'set_pc' (which exists in the generic loader now) should
>> +   be exposed to the user so that they can choose if the PC is set or not.
>>
>
> --
> Eric Blake   eblake redhat com    +1-919-301-3266
> Libvirt virtualization library http://libvirt.org
>

Re: [Qemu-devel] [PATCH v1 1/1] docs/generic-loader: Add restrictions and ToDos

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 780 bytes --]

On 10/03/2016 03:42 PM, Alistair Francis wrote:

>>>  An example of loading an ELF file which CPU0 will boot is shown below:
>>>      -device loader,file=./images/boot.elf,cpu-num=0
>>> +
>>> +Restrictions and ToDos
>>> +---------------------
>>
>> Might be worth it to have the --- line up with the text above.
> 
> It's the same length as all the other --- lines. Should I increase
> them all to the same length as the title?

It's only cosmetic, but yes, a lot of files under docs/ use
variable-length separators that act as an underline to the text above,
rather than fixed-length separators that have no relation to the text
they are emphasizing.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 604 bytes --]

Re: [Qemu-devel] [PATCH v1 1/1] docs/generic-loader: Add restrictions and ToDos

[Alistair Francis]

On Mon, Oct 3, 2016 at 1:45 PM, Eric Blake <eblake@redhat.com> wrote:
> On 10/03/2016 03:42 PM, Alistair Francis wrote:
>
>>>>  An example of loading an ELF file which CPU0 will boot is shown below:
>>>>      -device loader,file=./images/boot.elf,cpu-num=0
>>>> +
>>>> +Restrictions and ToDos
>>>> +---------------------
>>>
>>> Might be worth it to have the --- line up with the text above.
>>
>> It's the same length as all the other --- lines. Should I increase
>> them all to the same length as the title?
>
> It's only cosmetic, but yes, a lot of files under docs/ use
> variable-length separators that act as an underline to the text above,
> rather than fixed-length separators that have no relation to the text
> they are emphasizing.

Ok, I have sent a V2 that fixes the line length.

Thanks,

Alistair

>
> --
> Eric Blake   eblake redhat com    +1-919-301-3266
> Libvirt virtualization library http://libvirt.org
>