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

Message ID 20240313055712.3883100-1-srinuvasan.a@siemens.com
State Superseded, archived
Headers show
Series None | expand

Commit Message

Arjunan, Srinu March 13, 2024, 5:57 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

Florian Bezdeka March 13, 2024, 8:38 a.m. UTC | #1
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

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: