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

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

[srinuvasan.a]

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>
---
 .../recipes-app/example-raw/example-raw_0.3.bb    |  3 ++-
 .../example-raw/files/default-copyright.tmpl      | 15 +++++++++++++++
 meta/classes/debianize.bbclass                    |  4 ++++
 3 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright.tmpl

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..b4dfaa4d 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.tmpl"
 
 inherit dpkg-raw
 
diff --git a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
new file mode 100644
index 00000000..9c04255a
--- /dev/null
+++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
@@ -0,0 +1,15 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: ${PN}
+Upstream-Contact: Mentor Embedded <embedded_support@mentor.com>
+Source: https://github.com/MentorEmbedded/industrial-core
+
+Files: *
+Copyright: 2022, Siemens
+License: Siemens
+ .
+ This material contains trade secrets or otherwise confidential information
+ owned by Siemens Industry Software Inc.or its affiliates (collectively,
+ "Siemens"), or its licensors. Access to and use of this information is strictly
+ limited as set forth in the Customer's applicable agreements with Siemens.
+ .
+ Unpublished work. Copyright 2023 Siemens
diff --git a/meta/classes/debianize.bbclass b/meta/classes/debianize.bbclass
index 7de98673..5b9cd9dc 100644
--- a/meta/classes/debianize.bbclass
+++ b/meta/classes/debianize.bbclass
@@ -112,6 +112,10 @@ deb_debianize() {
 	else
 		deb_create_rules
 	fi
+	# Add the copyright if unpacked sources does not contain copyright file
+	if [ ! -f ${S}/debian/copyright.tmpl ] && [ -f ${WORKDIR}/default-copyright.tmpl ]; then
+		install -v -m 644 ${WORKDIR}/default-copyright.tmpl ${S}/debian/copyright
+	fi
 	# prepend a changelog-entry unless an existing changelog file already
 	# contains an entry with CHANGELOG_V
 	deb_add_changelog
-- 
2.34.1

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

[Jan Kiszka]

On 28.02.24 08:22, srinuvasan.a via isar-users 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>
> ---
>  .../recipes-app/example-raw/example-raw_0.3.bb    |  3 ++-
>  .../example-raw/files/default-copyright.tmpl      | 15 +++++++++++++++
>  meta/classes/debianize.bbclass                    |  4 ++++
>  3 files changed, 21 insertions(+), 1 deletion(-)
>  create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> 
> 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..b4dfaa4d 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.tmpl"
>  
>  inherit dpkg-raw
>  
> diff --git a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> new file mode 100644
> index 00000000..9c04255a
> --- /dev/null
> +++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> @@ -0,0 +1,15 @@
> +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
> +Upstream-Name: ${PN}
> +Upstream-Contact: Mentor Embedded <embedded_support@mentor.com>
> +Source: https://github.com/MentorEmbedded/industrial-core
> +
> +Files: *
> +Copyright: 2022, Siemens
> +License: Siemens
> + .
> + This material contains trade secrets or otherwise confidential information
> + owned by Siemens Industry Software Inc.or its affiliates (collectively,
> + "Siemens"), or its licensors. Access to and use of this information is strictly
> + limited as set forth in the Customer's applicable agreements with Siemens.
> + .
> + Unpublished work. Copyright 2023 Siemens

Somehow I can't imagine you actually want to have this merged into an
open source project, do you? ;)

Jan

> diff --git a/meta/classes/debianize.bbclass b/meta/classes/debianize.bbclass
> index 7de98673..5b9cd9dc 100644
> --- a/meta/classes/debianize.bbclass
> +++ b/meta/classes/debianize.bbclass
> @@ -112,6 +112,10 @@ deb_debianize() {
>  	else
>  		deb_create_rules
>  	fi
> +	# Add the copyright if unpacked sources does not contain copyright file
> +	if [ ! -f ${S}/debian/copyright.tmpl ] && [ -f ${WORKDIR}/default-copyright.tmpl ]; then
> +		install -v -m 644 ${WORKDIR}/default-copyright.tmpl ${S}/debian/copyright
> +	fi
>  	# prepend a changelog-entry unless an existing changelog file already
>  	# contains an entry with CHANGELOG_V
>  	deb_add_changelog

-- 
Siemens AG, Technology
Linux Expert Center

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

[srinu]

[-- Attachment #1.1: Type: text/plain, Size: 3622 bytes --]



On Thursday, February 29, 2024 at 6:40:24 AM UTC+5:30 Jan Kiszka wrote:

On 28.02.24 08:22, srinuvasan.a via isar-users wrote: 
> From: Srinuvasan A <srinuv...@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 <srinuv...@siemens.com> 
> --- 
> .../recipes-app/example-raw/example-raw_0.3.bb | 3 ++- 
> .../example-raw/files/default-copyright.tmpl | 15 +++++++++++++++ 
> meta/classes/debianize.bbclass | 4 ++++ 
> 3 files changed, 21 insertions(+), 1 deletion(-) 
> create mode 100644 
meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
> 
> 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..b4dfaa4d 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.tmpl" 
> 
> inherit dpkg-raw 
> 
> diff --git 
a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
> new file mode 100644 
> index 00000000..9c04255a 
> --- /dev/null 
> +++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
> @@ -0,0 +1,15 @@ 
> +Format: 
https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 
> +Upstream-Name: ${PN} 
> +Upstream-Contact: Mentor Embedded <embedded...@mentor.com> 
> +Source: https://github.com/MentorEmbedded/industrial-core 
> + 
> +Files: * 
> +Copyright: 2022, Siemens 
> +License: Siemens 
> + . 
> + This material contains trade secrets or otherwise confidential 
information 
> + owned by Siemens Industry Software Inc.or its affiliates (collectively, 
> + "Siemens"), or its licensors. Access to and use of this information is 
strictly 
> + limited as set forth in the Customer's applicable agreements with 
Siemens. 
> + . 
> + Unpublished work. Copyright 2023 Siemens 

Somehow I can't imagine you actually want to have this merged into an 
open source project, do you? ;) 

Jan


    This PR we proposed for our downstream layer, here we have n no.of 
recipes which contains the LICENSE,
    based on the LICENSE variable we are installing this copyright file 
into the packages, and this would really 
    needed for our OSS clearing

     Do you have any thoughts to address this one in ISAR? 



> diff --git a/meta/classes/debianize.bbclass 
b/meta/classes/debianize.bbclass 
> index 7de98673..5b9cd9dc 100644 
> --- a/meta/classes/debianize.bbclass 
> +++ b/meta/classes/debianize.bbclass 
> @@ -112,6 +112,10 @@ deb_debianize() { 
> else 
> deb_create_rules 
> fi 
> + # Add the copyright if unpacked sources does not contain copyright file 
> + if [ ! -f ${S}/debian/copyright.tmpl ] && [ -f 
${WORKDIR}/default-copyright.tmpl ]; then 
> + install -v -m 644 ${WORKDIR}/default-copyright.tmpl 
${S}/debian/copyright 
> + fi 
> # prepend a changelog-entry unless an existing changelog file already 
> # contains an entry with CHANGELOG_V 
> deb_add_changelog 

-- 
Siemens AG, Technology 
Linux Expert Center 


[-- Attachment #1.2: Type: text/html, Size: 5321 bytes --]

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

[Florian Bezdeka]

Hi,

On Wed, 2024-02-28 at 12:52 +0530, srinuvasan.a via isar-users 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>
> ---
>  .../recipes-app/example-raw/example-raw_0.3.bb    |  3 ++-
>  .../example-raw/files/default-copyright.tmpl      | 15 +++++++++++++++
>  meta/classes/debianize.bbclass                    |  4 ++++
>  3 files changed, 21 insertions(+), 1 deletion(-)
>  create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> 
> 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..b4dfaa4d 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.tmpl"
>  
>  inherit dpkg-raw
>  
> diff --git a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> new file mode 100644
> index 00000000..9c04255a
> --- /dev/null
> +++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> @@ -0,0 +1,15 @@
> +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
> +Upstream-Name: ${PN}
> +Upstream-Contact: Mentor Embedded <embedded_support@mentor.com>
> +Source: https://github.com/MentorEmbedded/industrial-core

Mentor or Siemens? And how did you make sure that "we" really hold the
copyright?

> +
> +Files: *
> +Copyright: 2022, Siemens
> +License: Siemens

Wrong year...

> + .
> + This material contains trade secrets or otherwise confidential information
> + owned by Siemens Industry Software Inc.or its affiliates (collectively,
> + "Siemens"), or its licensors. Access to and use of this information is strictly
> + limited as set forth in the Customer's applicable agreements with Siemens.
> + .
> + Unpublished work. Copyright 2023 Siemens

Nope. Now its published and in addition: wrong year...

> diff --git a/meta/classes/debianize.bbclass b/meta/classes/debianize.bbclass
> index 7de98673..5b9cd9dc 100644
> --- a/meta/classes/debianize.bbclass
> +++ b/meta/classes/debianize.bbclass
> @@ -112,6 +112,10 @@ deb_debianize() {
>  	else
>  		deb_create_rules
>  	fi
> +	# Add the copyright if unpacked sources does not contain copyright file
> +	if [ ! -f ${S}/debian/copyright.tmpl ] && [ -f ${WORKDIR}/default-copyright.tmpl ]; then
> +		install -v -m 644 ${WORKDIR}/default-copyright.tmpl ${S}/debian/copyright
> +	fi

This magic should be documented somewhere - after we agreed that this
is really the best way to add such a copyright file.

>  	# prepend a changelog-entry unless an existing changelog file already
>  	# contains an entry with CHANGELOG_V
>  	deb_add_changelog
> -- 
> 2.34.1

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

[Jan Kiszka]

On 29.02.24 06:02, 'srinu' via isar-users wrote:
> 
> 
> On Thursday, February 29, 2024 at 6:40:24 AM UTC+5:30 Jan Kiszka wrote:
> 
>     On 28.02.24 08:22, srinuvasan.a via isar-users wrote:
>     > From: Srinuvasan A <srinuv...@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 <srinuv...@siemens.com>
>     > ---
>     > .../recipes-app/example-raw/example-raw_0.3.bb
>     <http://example-raw_0.3.bb> | 3 ++-
>     > .../example-raw/files/default-copyright.tmpl | 15 +++++++++++++++
>     > meta/classes/debianize.bbclass | 4 ++++
>     > 3 files changed, 21 insertions(+), 1 deletion(-)
>     > create mode 100644
>     meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
>     >
>     > diff --git a/meta-isar/recipes-app/example-raw/example-raw_0.3.bb
>     <http://example-raw_0.3.bb>
>     b/meta-isar/recipes-app/example-raw/example-raw_0.3.bb
>     <http://example-raw_0.3.bb>
>     > index ffa14340..b4dfaa4d 100644
>     > --- a/meta-isar/recipes-app/example-raw/example-raw_0.3.bb
>     <http://example-raw_0.3.bb>
>     > +++ b/meta-isar/recipes-app/example-raw/example-raw_0.3.bb
>     <http://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.tmpl"
>     >
>     > inherit dpkg-raw
>     >
>     > diff --git
>     a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
>     b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
>     > new file mode 100644
>     > index 00000000..9c04255a
>     > --- /dev/null
>     > +++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
>     > @@ -0,0 +1,15 @@
>     > +Format:
>     https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
>     <https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/>
>     > +Upstream-Name: ${PN}
>     > +Upstream-Contact: Mentor Embedded <embedded...@mentor.com>
>     > +Source: https://github.com/MentorEmbedded/industrial-core
>     <https://github.com/MentorEmbedded/industrial-core>
>     > +
>     > +Files: *
>     > +Copyright: 2022, Siemens
>     > +License: Siemens
>     > + .
>     > + This material contains trade secrets or otherwise confidential
>     information
>     > + owned by Siemens Industry Software Inc.or its affiliates
>     (collectively,
>     > + "Siemens"), or its licensors. Access to and use of this
>     information is strictly
>     > + limited as set forth in the Customer's applicable agreements
>     with Siemens.
>     > + .
>     > + Unpublished work. Copyright 2023 Siemens
> 
>     Somehow I can't imagine you actually want to have this merged into an
>     open source project, do you? ;)
> 
>     Jan
> 
> 
>     This PR we proposed for our downstream layer, here we have n no.of
> recipes which contains the LICENSE,
>     based on the LICENSE variable we are installing this copyright file
> into the packages, and this would really 
>     needed for our OSS clearing
> 
>      Do you have any thoughts to address this one in ISAR? 
> 

There a two things to clearly tell apart here:
1) A mechanism to inject a default copyright file into an ad-hoc
   debianized package
2) The default license text to use here, even if just as an example

Regarding 2), it is absolutely obvious for everyone thinking just a few
seconds that this can never be any proprietary, Siemens "infected" text.
If at all, this can only be the default license of the containing OSS
project, which would be either MIT or GPL here, more likely MIT.

Having 1) as additional feature of debianize.bbclass is possible, but
please first clarify which of the two versions you sent should be
reviewed. And as you have to fix the example license anyway, follow up
with a clearly marked v2 for that purpose.

Jan

-- 
Siemens AG, Technology
Linux Expert Center

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

[srinuvasan.a]

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.tmpl  | 21 +++++++++++++++++++
 meta/classes/debianize.bbclass                |  4 ++++
 4 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright.tmpl

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.
+
 ### 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..b4dfaa4d 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.tmpl"
 
 inherit dpkg-raw
 
diff --git a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
new file mode 100644
index 00000000..8bede266
--- /dev/null
+++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 srinuvasan
+
+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..29898aeb 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.tmpl ] && [ -f ${WORKDIR}/default-copyright.tmpl ]; then
+		install -v -m 644 ${WORKDIR}/default-copyright.tmpl ${S}/debian/copyright
+	fi
 	# prepend a changelog-entry unless an existing changelog file already
 	# contains an entry with CHANGELOG_V
 	deb_add_changelog
-- 
2.34.1

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

[Jan Kiszka]

On 07.03.24 15:48, 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.tmpl  | 21 +++++++++++++++++++
>  meta/classes/debianize.bbclass                |  4 ++++
>  4 files changed, 29 insertions(+), 1 deletion(-)
>  create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> 
> 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.
> +
>  ### 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..b4dfaa4d 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.tmpl"
>  
>  inherit dpkg-raw
>  
> diff --git a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> new file mode 100644
> index 00000000..8bede266
> --- /dev/null
> +++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl
> @@ -0,0 +1,21 @@
> +MIT License
> +
> +Copyright (c) 2024 srinuvasan

We need to be accurate here. You do not have personal copyright on any
of these files, rather (according to git):

Copyright (c) 2017-2014, Siemens
Copyright (c) 2022 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..29898aeb 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

...do not...

> +	if [ ! -f ${S}/debian/copyright.tmpl ] && [ -f ${WORKDIR}/default-copyright.tmpl ]; then

Why *.tmpl? This file is not processed by the templating class, is it?

> +		install -v -m 644 ${WORKDIR}/default-copyright.tmpl ${S}/debian/copyright
> +	fi
>  	# prepend a changelog-entry unless an existing changelog file already
>  	# contains an entry with CHANGELOG_V
>  	deb_add_changelog

Jan

-- 
Siemens AG, Technology
Linux Expert Center

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

[srinu]

[-- Attachment #1.1: Type: text/plain, Size: 4677 bytes --]



On Friday, March 8, 2024 at 12:45:08 PM UTC+5:30 Jan Kiszka wrote:

On 07.03.24 15:48, srinuv...@siemens.com wrote: 
> From: Srinuvasan A <srinuv...@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 <srinuv...@siemens.com> 
> --- 
> doc/user_manual.md | 2 ++ 
> .../example-raw/example-raw_0.3.bb | 3 ++- 
> .../example-raw/files/default-copyright.tmpl | 21 +++++++++++++++++++ 
> meta/classes/debianize.bbclass | 4 ++++ 
> 4 files changed, 29 insertions(+), 1 deletion(-) 
> create mode 100644 
meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
> 
> 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. 
> + 
> ### 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..b4dfaa4d 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.tmpl" 
> 
> inherit dpkg-raw 
> 
> diff --git 
a/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
> new file mode 100644 
> index 00000000..8bede266 
> --- /dev/null 
> +++ b/meta-isar/recipes-app/example-raw/files/default-copyright.tmpl 
> @@ -0,0 +1,21 @@ 
> +MIT License 
> + 
> +Copyright (c) 2024 srinuvasan 

We need to be accurate here. You do not have personal copyright on any 
of these files, rather (according to git): 

Copyright (c) 2017-2014, Siemens 
Copyright (c) 2022 ilbers GmbH 


    got it, thanks 

> + 
> +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..29898aeb 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 

...do not... 

> + if [ ! -f ${S}/debian/copyright.tmpl ] && [ -f 
${WORKDIR}/default-copyright.tmpl ]; then 

Why *.tmpl? This file is not processed by the templating class, is it?


    Yes, will update to normal file. 



> + install -v -m 644 ${WORKDIR}/default-copyright.tmpl 
${S}/debian/copyright 
> + fi 
> # prepend a changelog-entry unless an existing changelog file already 
> # contains an entry with CHANGELOG_V 
> deb_add_changelog 

Jan 

-- 
Siemens AG, Technology 
Linux Expert Center 


[-- Attachment #1.2: Type: text/html, Size: 6499 bytes --]

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

[srinuvasan.a]

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.
+
 ### 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
-- 
2.34.1

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

[Jan Kiszka]

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

[PATCH v4 1/2] meta/classes/debianize: Add copyright file to debian folder

[srinuvasan.a]

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>
---
 .../example-raw/example-raw_0.3.bb            |  3 ++-
 .../example-raw/files/default-copyright       | 22 +++++++++++++++++++
 meta/classes/debianize.bbclass                |  4 ++++
 3 files changed, 28 insertions(+), 1 deletion(-)
 create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright

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

[PATCH v4 2/2] doc/user_manual: add a section for debianize class

[srinuvasan.a]

From: Srinuvasan A <srinuvasan.a@siemens.com>

Add additional information about debianize class for generating the
required files under debian directory.

Signed-off-by: Srinuvasan A <srinuvasan.a@siemens.com>
---
 doc/user_manual.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index bc730243..43c75451 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -907,6 +907,14 @@ The shell function `deb_debianize` creates a `debian` folder. But it will not ov
 
 Have a look at meta-isar/recipes-app/samefile/samefile_2.14.bb and meta/classes/debianize.bbclass for an example and the implementation.
 
+Here ISAR's debianize class generate the folllowing files:
+
+Create control file if sources does not contain a control file
+Create rules file if sources does not contain a rules file
+Add the copyright if unpacked sources does not contain copyright file, please check the example-raw recipe
+Add the changelog and hooks into the debian directories if WORKDIR contains the files
+
+
 ### Packages without source
 
 If your customization is not about compiling from source there is a second way of creating `deb` packages. That way can be used for cases like:
-- 
2.34.1

Re: [PATCH v4 2/2] doc/user_manual: add a section for debianize class

[srinu]

[-- Attachment #1.1: Type: text/plain, Size: 1504 bytes --]

Hi All,

              Please merge this changes if no objection.

Thanks,
Srinu

On Monday, March 11, 2024 at 11:52:26 AM UTC+5:30 srinuv...@siemens.com 
wrote:

> From: Srinuvasan A <srinuv...@siemens.com>
>
> Add additional information about debianize class for generating the
> required files under debian directory.
>
> Signed-off-by: Srinuvasan A <srinuv...@siemens.com>
> ---
> doc/user_manual.md | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/doc/user_manual.md b/doc/user_manual.md
> index bc730243..43c75451 100644
> --- a/doc/user_manual.md
> +++ b/doc/user_manual.md
> @@ -907,6 +907,14 @@ The shell function `deb_debianize` creates a `debian` 
> folder. But it will not ov
>
> Have a look at meta-isar/recipes-app/samefile/samefile_2.14.bb and 
> meta/classes/debianize.bbclass for an example and the implementation.
>
> +Here ISAR's debianize class generate the folllowing files:
> +
> +Create control file if sources does not contain a control file
> +Create rules file if sources does not contain a rules file
> +Add the copyright if unpacked sources does not contain copyright file, 
> please check the example-raw recipe
> +Add the changelog and hooks into the debian directories if WORKDIR 
> contains the files
> +
> +
> ### Packages without source
>
> If your customization is not about compiling from source there is a second 
> way of creating `deb` packages. That way can be used for cases like:
> -- 
> 2.34.1
>
>

[-- Attachment #1.2: Type: text/html, Size: 2181 bytes --]

Re: [PATCH v4 1/2] meta/classes/debianize: Add copyright file to debian folder

[Jan Kiszka]

On 11.03.24 07:22, 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>
> ---
>  .../example-raw/example-raw_0.3.bb            |  3 ++-
>  .../example-raw/files/default-copyright       | 22 +++++++++++++++++++
>  meta/classes/debianize.bbclass                |  4 ++++
>  3 files changed, 28 insertions(+), 1 deletion(-)
>  create mode 100644 meta-isar/recipes-app/example-raw/files/default-copyright
> 
> 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

This looks good to me.

Thanks,
Jan

-- 
Siemens AG, Technology
Linux Expert Center

Re: [PATCH v4 2/2] doc/user_manual: add a section for debianize class

[Jan Kiszka]

On 11.03.24 07:22, srinuvasan.a@siemens.com wrote:
> From: Srinuvasan A <srinuvasan.a@siemens.com>
> 
> Add additional information about debianize class for generating the
> required files under debian directory.
> 
> Signed-off-by: Srinuvasan A <srinuvasan.a@siemens.com>
> ---
>  doc/user_manual.md | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/user_manual.md b/doc/user_manual.md
> index bc730243..43c75451 100644
> --- a/doc/user_manual.md
> +++ b/doc/user_manual.md
> @@ -907,6 +907,14 @@ The shell function `deb_debianize` creates a `debian` folder. But it will not ov
>  
>  Have a look at meta-isar/recipes-app/samefile/samefile_2.14.bb and meta/classes/debianize.bbclass for an example and the implementation.
>  
> +Here ISAR's debianize class generate the folllowing files:

generates

> +
> +Create control file if sources does not contain a control file
> +Create rules file if sources does not contain a rules file
> +Add the copyright if unpacked sources does not contain copyright file, please check the example-raw recipe
> +Add the changelog and hooks into the debian directories if WORKDIR contains the files

This is written like a bullet list but not annotated as such. Please
either do that write plain sentences.

The list above is missing maintainer scripts (pre/post/inst/rm).

Jan

> +
> +
>  ### Packages without source
>  
>  If your customization is not about compiling from source there is a second way of creating `deb` packages. That way can be used for cases like:

-- 
Siemens AG, Technology
Linux Expert Center

[PATCH v5 2/2] doc/user_manual: add a section for debianize class

[srinuvasan.a]

From: Srinuvasan A <srinuvasan.a@siemens.com>

Add additional information about debianize class for generating the
required files under debian directory.

Signed-off-by: Srinuvasan A <srinuvasan.a@siemens.com>
---
 doc/user_manual.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index bc730243..3e356df0 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -907,6 +907,14 @@ The shell function `deb_debianize` creates a `debian` folder. But it will not ov
 
 Have a look at meta-isar/recipes-app/samefile/samefile_2.14.bb and meta/classes/debianize.bbclass for an example and the implementation.
 
+Here ISAR's debianize class generates the following files:
+
+ - Create control file if sources does not contain a control file
+ - Create rules file if sources does not contain a rules file
+ - Add the copyright if unpacked sources does not contain copyright file, please check the example-raw recipe
+ - Add the changelog and hooks( pre/post/inst/rm ) into the debian directories if WORKDIR contains the files
+
+
 ### Packages without source
 
 If your customization is not about compiling from source there is a second way of creating `deb` packages. That way can be used for cases like:
-- 
2.34.1

Re: [PATCH v5 2/2] doc/user_manual: add a section for debianize class

[Florian Bezdeka]

On Wed, 2024-03-13 at 11:27 +0530, srinuvasan.a via isar-users wrote:
> From: Srinuvasan A <srinuvasan.a@siemens.com>
> 
> Add additional information about debianize class for generating the
> required files under debian directory.
> 
> Signed-off-by: Srinuvasan A <srinuvasan.a@siemens.com>
> ---
>  doc/user_manual.md | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/user_manual.md b/doc/user_manual.md
> index bc730243..3e356df0 100644
> --- a/doc/user_manual.md
> +++ b/doc/user_manual.md
> @@ -907,6 +907,14 @@ The shell function `deb_debianize` creates a `debian` folder. But it will not ov
>  
>  Have a look at meta-isar/recipes-app/samefile/samefile_2.14.bb and meta/classes/debianize.bbclass for an example and the implementation.
>  
> +Here ISAR's debianize class generates the following files:
> +
> + - Create control file if sources does not contain a control file
> + - Create rules file if sources does not contain a rules file
> + - Add the copyright if unpacked sources does not contain copyright file, please check the example-raw recipe

This is a bit misleading, no? We hopefully do not generate any license
file by default if there is none. We move a supplied license file to
the right location. No?

My point is "debianize class generates" vs. "add the copyright".

> + - Add the changelog and hooks( pre/post/inst/rm ) into the debian directories if WORKDIR contains the files
> +
> +
>  ### Packages without source
>  
>  If your customization is not about compiling from source there is a second way of creating `deb` packages. That way can be used for cases like:

[PATCH v6 2/2] doc/user_manual: add a section for debianize class

[srinuvasan.a]

From: Srinuvasan A <srinuvasan.a@siemens.com>

Add additional information about debianize class for generating/adding the
required files under debian directory.

Signed-off-by: Srinuvasan A <srinuvasan.a@siemens.com>
---
 doc/user_manual.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index bc730243..52f04aa1 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -907,6 +907,14 @@ The shell function `deb_debianize` creates a `debian` folder. But it will not ov
 
 Have a look at meta-isar/recipes-app/samefile/samefile_2.14.bb and meta/classes/debianize.bbclass for an example and the implementation.
 
+Here ISAR's debianize class generates/adds the following files under debian directory:
+
+ - Create control file if sources does not contain a control file
+ - Create rules file if sources does not contain a rules file
+ - Add the copyright if unpacked sources does not contain copyright file, as well as the recipe should supply the copyright file
+ - Add the changelog and hooks( pre/post/inst/rm ) into the debian directories if WORKDIR contains the files
+
+
 ### Packages without source
 
 If your customization is not about compiling from source there is a second way of creating `deb` packages. That way can be used for cases like:
-- 
2.34.1

Re: [PATCH v4 1/2] meta/classes/debianize: Add copyright file to debian folder

[Uladzimir Bely]

On Mon, 2024-03-11 at 11:52 +0530, 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>

Applied to next, thanks.

Re: [PATCH v6 2/2] doc/user_manual: add a section for debianize class

[Uladzimir Bely]

On Wed, 2024-03-13 at 15:14 +0530, srinuvasan.a@siemens.com wrote:
> From: Srinuvasan A <srinuvasan.a@siemens.com>
> 
> Add additional information about debianize class for
> generating/adding the
> required files under debian directory.
> 
> Signed-off-by: Srinuvasan A <srinuvasan.a@siemens.com>
> ---
>  doc/user_manual.md | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 

Applied to next, thanks.