diff mbox series

[v2,2/2] docs: remoteproc: Update section header name requirement

Message ID 1670924929-26507-3-git-send-email-quic_srivasam@quicinc.com (mailing list archive)
State Superseded
Headers show
Series Update section header name check | expand

Commit Message

Srinivasa Rao Mandadapu Dec. 13, 2022, 9:48 a.m. UTC
Add section header name requirement specification in elf segments.

Signed-off-by: Srinivasa Rao Mandadapu <quic_srivasam@quicinc.com>
---
 Documentation/staging/remoteproc.rst | 2 ++
 1 file changed, 2 insertions(+)

Comments

Philippe Mathieu-Daudé Dec. 15, 2022, 7:25 a.m. UTC | #1
On 13/12/22 10:48, Srinivasa Rao Mandadapu wrote:
> Add section header name requirement specification in elf segments.
> 
> Signed-off-by: Srinivasa Rao Mandadapu <quic_srivasam@quicinc.com>
> ---
>   Documentation/staging/remoteproc.rst | 2 ++
>   1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/staging/remoteproc.rst b/Documentation/staging/remoteproc.rst
> index 348ee7e..3125030 100644
> --- a/Documentation/staging/remoteproc.rst
> +++ b/Documentation/staging/remoteproc.rst
> @@ -245,6 +245,8 @@ if the remote processor is accessing memory directly).
>   
>   In addition to the standard ELF segments, most remote processors would
>   also include a special section which we call "the resource table".
> +This resource table section name may have anything appended after it,
> +but it must start with ".resource_table"

What do you think of:

    In addition to the standard ELF segments, most remote processors would
    also include a special section which we call the "resource table".
    A "resource table" section name must start with the ".resource_table"
    prefix, optionally having a more descriptive string appended. For
    example, ".resource_table.my_rproc" is a valid section name.

Regards,

Phil.
Srinivasa Rao Mandadapu Dec. 20, 2022, 7:27 a.m. UTC | #2
On 12/15/2022 12:55 PM, Philippe Mathieu-Daudé wrote:
Thanks for your time Phil!!!
> On 13/12/22 10:48, Srinivasa Rao Mandadapu wrote:
>> Add section header name requirement specification in elf segments.
>>
>> Signed-off-by: Srinivasa Rao Mandadapu <quic_srivasam@quicinc.com>
>> ---
>>   Documentation/staging/remoteproc.rst | 2 ++
>>   1 file changed, 2 insertions(+)
>>
>> diff --git a/Documentation/staging/remoteproc.rst 
>> b/Documentation/staging/remoteproc.rst
>> index 348ee7e..3125030 100644
>> --- a/Documentation/staging/remoteproc.rst
>> +++ b/Documentation/staging/remoteproc.rst
>> @@ -245,6 +245,8 @@ if the remote processor is accessing memory 
>> directly).
>>     In addition to the standard ELF segments, most remote processors 
>> would
>>   also include a special section which we call "the resource table".
>> +This resource table section name may have anything appended after it,
>> +but it must start with ".resource_table"
>
> What do you think of:
>
>    In addition to the standard ELF segments, most remote processors would
>    also include a special section which we call the "resource table".
>    A "resource table" section name must start with the ".resource_table"
>    prefix, optionally having a more descriptive string appended. For
>    example, ".resource_table.my_rproc" is a valid section name.
Okay. Will change accordingly and re-spin the patch set.
>
> Regards,
>
> Phil.
diff mbox series

Patch

diff --git a/Documentation/staging/remoteproc.rst b/Documentation/staging/remoteproc.rst
index 348ee7e..3125030 100644
--- a/Documentation/staging/remoteproc.rst
+++ b/Documentation/staging/remoteproc.rst
@@ -245,6 +245,8 @@  if the remote processor is accessing memory directly).
 
 In addition to the standard ELF segments, most remote processors would
 also include a special section which we call "the resource table".
+This resource table section name may have anything appended after it,
+but it must start with ".resource_table"
 
 The resource table contains system resources that the remote processor
 requires before it should be powered on, such as allocation of physically