Re: [PATCH v3] meta/classes/debianize: Add copyright file to debian folder

[Jan Kiszka <jan.kiszka@siemens.com>]

On 08.03.24 15:26, srinuvasan.a@siemens.com wrote:
> From: Srinuvasan A <srinuvasan.a@siemens.com>
> 
> In downstream layer we uses copyright files for most of the packages,
> this is very important for our OSS clearing.
> 
> User can add the copyright to the required recipe, then the generated
> packages from the recipes contains the debian/copyright file.
> 
> Added example copyright file in example-raw recipe.
> 
> Signed-off-by: Srinuvasan A <srinuvasan.a@siemens.com>
> ---
>  doc/user_manual.md                            |  2 ++
>  .../example-raw/example-raw_0.3.bb            |  3 ++-
>  .../example-raw/files/default-copyright       | 22 +++++++++++++++++++
>  meta/classes/debianize.bbclass                |  4 ++++
>  4 files changed, 30 insertions(+), 1 deletion(-)
>  create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright
> 
> diff --git a/doc/user_manual.md b/doc/user_manual.md
> index bc730243..6b851985 100644
> --- a/doc/user_manual.md
> +++ b/doc/user_manual.md
> @@ -940,6 +940,8 @@ Other (optional) customization variables include:
>   - `DEBIAN_PROVIDES` - declare a virtual package to satisfy dependencies
>   - `DEBIAN_REPLACES` - to replace a package with another
>  
> +Added provision to generate copyright file in debian packages, this would be helpful for downstream project's OSS clearing.

Just noticed this: This reads like a changelog, not like a manual entry.
You want to say that dpgk-raw automatically includes copyright files
files into the package if provided. But then there is much more missing
already in the manual as it does not explain what other files
deb_debianize and, thus, dpkg-raw picks up (rules, control, maintainer
scripts). So, if you want to enhance the documentation, better write a
separate patch that then can also mention copyright.

> +
>  ### Prebuilt .deb packages from somewhere
>  
>  In some cases you might find yourself having a `.deb` that someone else built,
> diff --git a/meta-isar/recipes-app/example-raw/example-raw_0.3.bb b/meta-isar/recipes-app/example-raw/example-raw_0.3.bb
> index ffa14340..35f4b3d9 100644
> --- a/meta-isar/recipes-app/example-raw/example-raw_0.3.bb
> +++ b/meta-isar/recipes-app/example-raw/example-raw_0.3.bb
> @@ -9,7 +9,8 @@ DEBIAN_DEPENDS = "adduser, apt (>= 0.4.2)"
>  
>  SRC_URI = "file://README \
>  	   file://postinst \
> -	   file://rules"
> +	   file://rules \
> +	   file://default-copyright"
>  
>  inherit dpkg-raw
>  
> diff --git a/meta-isar/recipes-app/example-raw/files/default-copyright b/meta-isar/recipes-app/example-raw/files/default-copyright
> new file mode 100644
> index 00000000..3511cb51
> --- /dev/null
> +++ b/meta-isar/recipes-app/example-raw/files/default-copyright
> @@ -0,0 +1,22 @@
> +MIT License
> +
> +Copyright (c) 2017-2024, Siemens
> +Copyright (c) 2024 ilbers GmbH
> +
> +Permission is hereby granted, free of charge, to any person obtaining a copy
> +of this software and associated documentation files (the "Software"), to deal
> +in the Software without restriction, including without limitation the rights
> +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
> +copies of the Software, and to permit persons to whom the Software is
> +furnished to do so, subject to the following conditions:
> +
> +The above copyright notice and this permission notice shall be included in all
> +copies or substantial portions of the Software.
> +
> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
> +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
> +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
> +SOFTWARE.
> diff --git a/meta/classes/debianize.bbclass b/meta/classes/debianize.bbclass
> index f256333d..0febcbe2 100644
> --- a/meta/classes/debianize.bbclass
> +++ b/meta/classes/debianize.bbclass
> @@ -120,6 +120,10 @@ deb_debianize() {
>  	else
>  		deb_create_rules
>  	fi
> +	# Add the copyright if unpacked sources does not contain copyright file
> +	if [ ! -f ${S}/debian/copyright ] && [ -f ${WORKDIR}/default-copyright ]; then
> +		install -v -m 644 ${WORKDIR}/default-copyright ${S}/debian/copyright
> +	fi
>  	# prepend a changelog-entry unless an existing changelog file already
>  	# contains an entry with CHANGELOG_V
>  	deb_add_changelog

Rest looks good to me now!

Jan

-- 
Siemens AG, Technology
Linux Expert Center