diff mbox series

[4/6] meta/lib/oe/spdx30_tasks.py: improve debug log in add_package_files

Message ID 20241026032519.1968518-5-hongxu.jia@windriver.com
State Accepted, archived
Commit a2f1498f3db44f34599b86221b688e1abf08a3c7
Headers show
Series Support SPDX include source for work-share directory | expand

Commit Message

Hongxu Jia Oct. 26, 2024, 3:25 a.m. UTC
While SPDX_INCLUDE_SOURCES = "1" [1], there are mess of `Adding file'
in debug log
'''
DEBUG: Adding file tmp/work/x86_64-linux/gettext-minimal-native/0.22.5/spdx/3.0.1/work/sources-unpack/COPYING to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/e2c2366654a818397af8b8ddb45fda88c2c71aa2d71695861f82376a658d8e66/document/gettext-minimal-native
DEBUG: Adding file tmp/work/x86_64-linux/gettext-minimal-native/0.22.5/spdx/3.0.1/work/gettext-0.22.5/.tarball-version to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/e2c2366654a818397af8b8ddb45fda88c2c71aa2d71695861f82376a658d8e66/document/gettext-minimal-native
'''

Summary the total number other than print for each file.
'''
DEBUG: Start adding files to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/f5e0e04913ac4c595be791fc001d545a77519ed6ee8c743deef721ca0898bc94/document/gettext-minimal-native
DEBUG: Added 7201 files to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/f5e0e04913ac4c595be791fc001d545a77519ed6ee8c743deef721ca0898bc94/document/gettext-minimal-native
'''
Correct file_counter to start with 0

[1] https://docs.yoctoproject.org/dev/ref-manual/variables.html#term-SPDX_INCLUDE_SOURCES

Signed-off-by: Hongxu Jia <hongxu.jia@windriver.com>
---
 meta/lib/oe/spdx30_tasks.py | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

Joshua Watt Oct. 28, 2024, 7:54 p.m. UTC | #1
On Fri, Oct 25, 2024 at 9:25 PM Hongxu Jia <hongxu.jia@windriver.com> wrote:
>
> While SPDX_INCLUDE_SOURCES = "1" [1], there are mess of `Adding file'
> in debug log
> '''
> DEBUG: Adding file tmp/work/x86_64-linux/gettext-minimal-native/0.22.5/spdx/3.0.1/work/sources-unpack/COPYING to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/e2c2366654a818397af8b8ddb45fda88c2c71aa2d71695861f82376a658d8e66/document/gettext-minimal-native
> DEBUG: Adding file tmp/work/x86_64-linux/gettext-minimal-native/0.22.5/spdx/3.0.1/work/gettext-0.22.5/.tarball-version to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/e2c2366654a818397af8b8ddb45fda88c2c71aa2d71695861f82376a658d8e66/document/gettext-minimal-native
> '''
>
> Summary the total number other than print for each file.
> '''
> DEBUG: Start adding files to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/f5e0e04913ac4c595be791fc001d545a77519ed6ee8c743deef721ca0898bc94/document/gettext-minimal-native
> DEBUG: Added 7201 files to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/f5e0e04913ac4c595be791fc001d545a77519ed6ee8c743deef721ca0898bc94/document/gettext-minimal-native
> '''
> Correct file_counter to start with 0
>
> [1] https://docs.yoctoproject.org/dev/ref-manual/variables.html#term-SPDX_INCLUDE_SOURCES
>
> Signed-off-by: Hongxu Jia <hongxu.jia@windriver.com>
> ---
>  meta/lib/oe/spdx30_tasks.py | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
>
> diff --git a/meta/lib/oe/spdx30_tasks.py b/meta/lib/oe/spdx30_tasks.py
> index e0b656d81f..575b66ea5d 100644
> --- a/meta/lib/oe/spdx30_tasks.py
> +++ b/meta/lib/oe/spdx30_tasks.py
> @@ -144,19 +144,19 @@ def add_package_files(
>
>      spdx_files = set()
>
> -    file_counter = 1
> +    bb.debug(1, "Start adding files to %s" % (objset.doc._id))

This probably has little value, so I'd just omit it?

> +    file_counter = 0
>      for subdir, dirs, files in os.walk(topdir):
>          dirs[:] = [d for d in dirs if d not in ignore_dirs]
>          if subdir == str(topdir):
>              dirs[:] = [d for d in dirs if d not in ignore_top_level_dirs]
>
> +
>          for file in files:
>              filepath = Path(subdir) / file
>              if filepath.is_symlink() or not filepath.is_file():
>                  continue
>
> -            bb.debug(1, "Adding file %s to %s" % (filepath, objset.doc._id))
> -
>              filename = str(filepath.relative_to(topdir))
>              file_purposes = get_purposes(filepath)
>
> @@ -187,6 +187,8 @@ def add_package_files(
>
>              file_counter += 1
>
> +    bb.debug(1, "Added %d files to %s" % (file_counter, objset.doc._id))

len(spdx_files) is more accurate than file_counter and means we don't
have to change it to start at 0

> +
>      return spdx_files
>
>
> --
> 2.25.1
>
Hongxu Jia Oct. 29, 2024, 3:17 a.m. UTC | #2
Confirm, v2 incoming

//Hongxu

On Fri, Oct 25, 2024 at 9:25 PM Hongxu Jia <hongxu.jia@windriver.com> wrote:
>
> While SPDX_INCLUDE_SOURCES = "1" [1], there are mess of `Adding file'
> in debug log
> '''
> DEBUG: Adding file tmp/work/x86_64-linux/gettext-minimal-native/0.22.5/spdx/3.0.1/work/sources-unpack/COPYING to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/e2c2366654a818397af8b8ddb45fda88c2c71aa2d71695861f82376a658d8e66/document/gettext-minimal-native
> DEBUG: Adding file tmp/work/x86_64-linux/gettext-minimal-native/0.22.5/spdx/3.0.1/work/gettext-0.22.5/.tarball-version to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/e2c2366654a818397af8b8ddb45fda88c2c71aa2d71695861f82376a658d8e66/document/gettext-minimal-native
> '''
>
> Summary the total number other than print for each file.
> '''
> DEBUG: Start adding files to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/f5e0e04913ac4c595be791fc001d545a77519ed6ee8c743deef721ca0898bc94/document/gettext-minimal-native
> DEBUG: Added 7201 files to http://spdx.org/spdxdocs/gettext-minimal-native-1fa0d5cb-2bb8-5631-9fab-cd219801733f/f5e0e04913ac4c595be791fc001d545a77519ed6ee8c743deef721ca0898bc94/document/gettext-minimal-native
> '''
> Correct file_counter to start with 0
>
> [1] https://docs.yoctoproject.org/dev/ref-manual/variables.html#term-SPDX_INCLUDE_SOURCES
>
> Signed-off-by: Hongxu Jia <hongxu.jia@windriver.com>
> ---
>  meta/lib/oe/spdx30_tasks.py | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
>
> diff --git a/meta/lib/oe/spdx30_tasks.py b/meta/lib/oe/spdx30_tasks.py
> index e0b656d81f..575b66ea5d 100644
> --- a/meta/lib/oe/spdx30_tasks.py
> +++ b/meta/lib/oe/spdx30_tasks.py
> @@ -144,19 +144,19 @@ def add_package_files(
>
>      spdx_files = set()
>
> -    file_counter = 1
> +    bb.debug(1, "Start adding files to %s" % (objset.doc._id))

This probably has little value, so I'd just omit it?

> +    file_counter = 0
>      for subdir, dirs, files in os.walk(topdir):
>          dirs[:] = [d for d in dirs if d not in ignore_dirs]
>          if subdir == str(topdir):
>              dirs[:] = [d for d in dirs if d not in ignore_top_level_dirs]
>
> +
>          for file in files:
>              filepath = Path(subdir) / file
>              if filepath.is_symlink() or not filepath.is_file():
>                  continue
>
> -            bb.debug(1, "Adding file %s to %s" % (filepath, objset.doc._id))
> -
>              filename = str(filepath.relative_to(topdir))
>              file_purposes = get_purposes(filepath)
>
> @@ -187,6 +187,8 @@ def add_package_files(
>
>              file_counter += 1
>
> +    bb.debug(1, "Added %d files to %s" % (file_counter, objset.doc._id))

len(spdx_files) is more accurate than file_counter and means we don't
have to change it to start at 0

> +
>      return spdx_files
>
>
> --
> 2.25.1
>
diff mbox series

Patch

diff --git a/meta/lib/oe/spdx30_tasks.py b/meta/lib/oe/spdx30_tasks.py
index e0b656d81f..575b66ea5d 100644
--- a/meta/lib/oe/spdx30_tasks.py
+++ b/meta/lib/oe/spdx30_tasks.py
@@ -144,19 +144,19 @@  def add_package_files(
 
     spdx_files = set()
 
-    file_counter = 1
+    bb.debug(1, "Start adding files to %s" % (objset.doc._id))
+    file_counter = 0
     for subdir, dirs, files in os.walk(topdir):
         dirs[:] = [d for d in dirs if d not in ignore_dirs]
         if subdir == str(topdir):
             dirs[:] = [d for d in dirs if d not in ignore_top_level_dirs]
 
+
         for file in files:
             filepath = Path(subdir) / file
             if filepath.is_symlink() or not filepath.is_file():
                 continue
 
-            bb.debug(1, "Adding file %s to %s" % (filepath, objset.doc._id))
-
             filename = str(filepath.relative_to(topdir))
             file_purposes = get_purposes(filepath)
 
@@ -187,6 +187,8 @@  def add_package_files(
 
             file_counter += 1
 
+    bb.debug(1, "Added %d files to %s" % (file_counter, objset.doc._id))
+
     return spdx_files