[PATCHv3] ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX

[PATCHv3] ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX

[Peter Kjellerstedt]

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---

PATCHv2: Removed the reference to split_and_strip_files().
PATCHv3: Changed "dbg package" to "``-dbg`` package".

 documentation/ref-manual/variables.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index e81a12030a..aaba23dbdf 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5085,6 +5085,14 @@ system and gives an overview of their function and contents.
       result of the package manager in use, see the
       ":ref:`package.bbclass <ref-classes-package>`" section.
 
+   :term:`PACKAGE_DEBUG_FILE_SUFFIX`
+      This suffix is added to the names of all files with debug symbols that go
+      into the ``-dbg`` package. It can be used to make the debug files produced
+      by one recipe unique to avoid them conflicting with identically named
+      debug files produced by another recipe. This may be needed since while the
+      target files may be split in multiple packages, the debug files for one
+      recipe are all in one package.
+
    :term:`PACKAGE_DEBUG_SPLIT_STYLE`
       Determines how to split up and package debug and source information
       when creating debugging packages to be used with the GNU Project

Re: [docs] [PATCHv3] ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX

[Michael Opdenacker]

On 1/7/22 6:04 PM, Peter Kjellerstedt wrote:
> Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> ---
>
> PATCHv2: Removed the reference to split_and_strip_files().
> PATCHv3: Changed "dbg package" to "``-dbg`` package".
>
>  documentation/ref-manual/variables.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index e81a12030a..aaba23dbdf 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -5085,6 +5085,14 @@ system and gives an overview of their function and contents.
>        result of the package manager in use, see the
>        ":ref:`package.bbclass <ref-classes-package>`" section.
>  
> +   :term:`PACKAGE_DEBUG_FILE_SUFFIX`
> +      This suffix is added to the names of all files with debug symbols that go
> +      into the ``-dbg`` package. It can be used to make the debug files produced
> +      by one recipe unique to avoid them conflicting with identically named
> +      debug files produced by another recipe. This may be needed since while the
> +      target files may be split in multiple packages, the debug files for one
> +      recipe are all in one package.
> +
>     :term:`PACKAGE_DEBUG_SPLIT_STYLE`
>        Determines how to split up and package debug and source information
>        when creating debugging packages to be used with the GNU Project


Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into "master-next".

Thanks for the patch!
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

RE: [docs] [PATCHv3] ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX

[Peter Kjellerstedt]

> -----Original Message-----
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Sent: den 10 januari 2022 15:39
> To: Peter Kjellerstedt <peter.kjellerstedt@axis.com>; docs@lists.yoctoproject.org
> Subject: Re: [docs] [PATCHv3] ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX
> 
> On 1/7/22 6:04 PM, Peter Kjellerstedt wrote:
> > Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
> > ---
> >
> > PATCHv2: Removed the reference to split_and_strip_files().
> > PATCHv3: Changed "dbg package" to "``-dbg`` package".
> >
> >  documentation/ref-manual/variables.rst | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> >
> > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> > index e81a12030a..aaba23dbdf 100644
> > --- a/documentation/ref-manual/variables.rst
> > +++ b/documentation/ref-manual/variables.rst
> > @@ -5085,6 +5085,14 @@ system and gives an overview of their function and contents.
> >        result of the package manager in use, see the
> >        ":ref:`package.bbclass <ref-classes-package>`" section.
> >
> > +   :term:`PACKAGE_DEBUG_FILE_SUFFIX`
> > +      This suffix is added to the names of all files with debug symbols that go
> > +      into the ``-dbg`` package. It can be used to make the debug files produced
> > +      by one recipe unique to avoid them conflicting with identically named
> > +      debug files produced by another recipe. This may be needed since while the
> > +      target files may be split in multiple packages, the debug files for one
> > +      recipe are all in one package.
> > +
> >     :term:`PACKAGE_DEBUG_SPLIT_STYLE`
> >        Determines how to split up and package debug and source information
> >        when creating debugging packages to be used with the GNU Project
> 
> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ... and merged into "master-next".
> 
> Thanks for the patch!
> Michael.

Just be aware that it still hasn't made it into meta...

//Peter

Re: [docs] [PATCHv3] ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX

[Michael Opdenacker]

On 1/10/22 3:52 PM, Peter Kjellerstedt wrote:
>
> Just be aware that it still hasn't made it into meta...


Oops, I removed it from master-next then.
Just keep me posted when the corresponding patch is merged.
Thanks
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com