diff mbox series

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

Message ID 1671523269-21154-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. 20, 2022, 8:01 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 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Mukesh Ojha Dec. 20, 2022, 12:51 p.m. UTC | #1
Hi,

On 12/20/2022 1:31 PM, Srinivasa Rao Mandadapu wrote:
> Add section header name requirement specification in elf segments.
> 
> Signed-off-by: Srinivasa Rao Mandadapu <quic_srivasam@quicinc.com>


LGTM.
Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com>

-Mukesh
> ---
>   Documentation/staging/remoteproc.rst | 5 ++++-
>   1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/staging/remoteproc.rst b/Documentation/staging/remoteproc.rst
> index 348ee7e..0c9c10a 100644
> --- a/Documentation/staging/remoteproc.rst
> +++ b/Documentation/staging/remoteproc.rst
> @@ -244,7 +244,10 @@ according to the specified device address (might be a physical address
>   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".
> +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.
>   
>   The resource table contains system resources that the remote processor
>   requires before it should be powered on, such as allocation of physically
diff mbox series

Patch

diff --git a/Documentation/staging/remoteproc.rst b/Documentation/staging/remoteproc.rst
index 348ee7e..0c9c10a 100644
--- a/Documentation/staging/remoteproc.rst
+++ b/Documentation/staging/remoteproc.rst
@@ -244,7 +244,10 @@  according to the specified device address (might be a physical address
 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".
+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.
 
 The resource table contains system resources that the remote processor
 requires before it should be powered on, such as allocation of physically