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

Message ID 20240311062202.3877203-2-srinuvasan.a@siemens.com
State Superseded, archived
Headers show
Series [v4,1/2] meta/classes/debianize: Add copyright file to debian folder | expand

Commit Message

Arjunan, Srinu March 11, 2024, 6:22 a.m. UTC
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(+)

Comments

Arjunan, Srinu March 12, 2024, 4:10 p.m. UTC | #1
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
>
>
Jan Kiszka March 12, 2024, 4:36 p.m. UTC | #2
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:

Patch

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: