ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX

Message ID 20211223103713.4552-1-pkj@axis.com
State New
Headers show
Series ref-manual: Add documentation of PACKAGE_DEBUG_FILE_SUFFIX | expand

Commit Message

Peter Kjellerstedt Dec. 23, 2021, 10:37 a.m. UTC
Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
---

This of course assumes that the corresponding change to OE-Core is
accepted.

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

Comments

Quentin Schulz Dec. 23, 2021, 12:29 p.m. UTC | #1
Hi Peter,

On December 23, 2021 11:37:13 AM GMT+01:00, Peter Kjellerstedt <peter.kjellerstedt@axis.com> wrote:
>Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
>---
>
>This of course assumes that the corresponding change to OE-Core is
>accepted.
>
> 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 e5216b3f36..52adcf1e4f 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 produced
>+      by split_and_strip_files(). It can be used to make the debug files

I don't think we care in the documentation about the name of the function in which this variable is used. The rest looks fine.

Cheers,
Quentin

>+      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

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index e5216b3f36..52adcf1e4f 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 produced
+      by split_and_strip_files(). 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