[PATCH] doc: Rework description of build dependencies installation

[PATCH] doc: Rework description of build dependencies installation

[Jan Kiszka]

From: Jan Kiszka <jan.kiszka@siemens.com>

Fold in sbuild and schroot packages so that everything needed for
building is in one list.

Move qemu out of this list because it is only optional.

Reorder the note about adding the user to the sbuild group so that it
introduces the related command.

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
---
 doc/user_manual.md | 24 +++++++++++-------------
 1 file changed, 11 insertions(+), 13 deletions(-)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 546ae75c..5b2387d8 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -78,37 +78,30 @@ apt install \
   parted \
   python3 \
   quilt \
-  qemu \
   qemu-user-static \
   reprepro \
   sudo \
   git-buildpackage \
-  pristine-tar
+  pristine-tar \
+  sbuild \
+  schroot
 ```

-Additional setup is required since `sbuild` is now used for package build.
-Install the following packages:
+If your host is >= buster, also install the following package.
 ```
-apt install \
-  sbuild \
-  schroot
+apt install python3-distutils
 ```
-Also, user who runs isar should be added to `sbuild` group.

 **NOTE:** sbuild version (<=0.78.1) packaged in Debian Buster doesn't support
 `$apt_keep_downloaded_packages` option which is required in Isar for
 populating `${DL_DIR}/deb`. So, host `sbuild` in this case should be manually
 upgraded to >=0.81.2 version from Debian Bullseye.

+Next, the user who should run Isar needs to be added to `sbuild` group.
 ```
 sudo gpasswd -a <username> sbuild
 ```

-If your host is >= buster, also install the following package.
-```
-apt install python3-distutils
-```
-
 If you want to generate containerized SDKs, also install the following
 packages: `umoci` and `skopeo`.
 Umoci is provided by Debian Buster and can be installed with
@@ -129,6 +122,11 @@ Notes:
   handled by QEMU (check e.g. `qemu-arm` in `/usr/sbin/update-binfmts
   --display`).

+To run images built for QEMU, you also need to install the related package:
+```
+apt install qemu
+```
+
 ### Setup Sudo

 Isar requires `sudo` rights without password to work with `chroot` and `debootstrap`. To add them, use the following steps:
--
2.35.3

Re: [PATCH] doc: Rework description of build dependencies installation

[Anton Mikanovich]

[-- Attachment #1: Type: text/plain, Size: 2611 bytes --]

26.08.2022 12:03, Jan Kiszka wrote:
> From: Jan Kiszka<jan.kiszka@siemens.com>
>
> Fold in sbuild and schroot packages so that everything needed for
> building is in one list.
>
> Move qemu out of this list because it is only optional.
>
> Reorder the note about adding the user to the sbuild group so that it
> introduces the related command.
>
> Signed-off-by: Jan Kiszka<jan.kiszka@siemens.com>
> ---
>   doc/user_manual.md | 24 +++++++++++-------------
>   1 file changed, 11 insertions(+), 13 deletions(-)
>
> diff --git a/doc/user_manual.md b/doc/user_manual.md
> index 546ae75c..5b2387d8 100644
> --- a/doc/user_manual.md
> +++ b/doc/user_manual.md
> @@ -78,37 +78,30 @@ apt install \
>     parted \
>     python3 \
>     quilt \
> -  qemu \
>     qemu-user-static \
>     reprepro \
>     sudo \
>     git-buildpackage \
> -  pristine-tar
> +  pristine-tar \
> +  sbuild \
> +  schroot
>   ```
>
> -Additional setup is required since `sbuild` is now used for package build.
> -Install the following packages:
> +If your host is >= buster, also install the following package.
>   ```
> -apt install \
> -  sbuild \
> -  schroot
> +apt install python3-distutils
>   ```
> -Also, user who runs isar should be added to `sbuild` group.
>
>   **NOTE:** sbuild version (<=0.78.1) packaged in Debian Buster doesn't support
>   `$apt_keep_downloaded_packages` option which is required in Isar for
>   populating `${DL_DIR}/deb`. So, host `sbuild` in this case should be manually
>   upgraded to >=0.81.2 version from Debian Bullseye.
>
> +Next, the user who should run Isar needs to be added to `sbuild` group.
>   ```
>   sudo gpasswd -a <username> sbuild
>   ```
>
> -If your host is >= buster, also install the following package.
> -```
> -apt install python3-distutils
> -```
> -
>   If you want to generate containerized SDKs, also install the following
>   packages: `umoci` and `skopeo`.
>   Umoci is provided by Debian Buster and can be installed with
> @@ -129,6 +122,11 @@ Notes:
>     handled by QEMU (check e.g. `qemu-arm` in `/usr/sbin/update-binfmts
>     --display`).
>
> +To run images built for QEMU, you also need to install the related package:
> +```
> +apt install qemu
> +```
> +
>   ### Setup Sudo
>
>   Isar requires `sudo` rights without password to work with `chroot` and `debootstrap`. To add them, use the following steps:
> --
> 2.35.3
>
Hello Jan,

How did you generate this patch?
It looks like some endline whitespaces were missed in the end of the 
first chunk,
so the patch became inapplicable.

There is no need to resend this one, just wanted to warn for the future 
commits.

[-- Attachment #2: Type: text/html, Size: 3328 bytes --]

Re: [PATCH] doc: Rework description of build dependencies installation

[Jan Kiszka]

On 29.08.22 12:26, Anton Mikanovich wrote:
> 26.08.2022 12:03, Jan Kiszka wrote:
>> From: Jan Kiszka <jan.kiszka@siemens.com>
>>
>> Fold in sbuild and schroot packages so that everything needed for
>> building is in one list.
>>
>> Move qemu out of this list because it is only optional.
>>
>> Reorder the note about adding the user to the sbuild group so that it
>> introduces the related command.
>>
>> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
>> ---
>>  doc/user_manual.md | 24 +++++++++++-------------
>>  1 file changed, 11 insertions(+), 13 deletions(-)
>>
>> diff --git a/doc/user_manual.md b/doc/user_manual.md
>> index 546ae75c..5b2387d8 100644
>> --- a/doc/user_manual.md
>> +++ b/doc/user_manual.md
>> @@ -78,37 +78,30 @@ apt install \
>>    parted \
>>    python3 \
>>    quilt \
>> -  qemu \
>>    qemu-user-static \
>>    reprepro \
>>    sudo \
>>    git-buildpackage \
>> -  pristine-tar
>> +  pristine-tar \
>> +  sbuild \
>> +  schroot
>>  ```
>>
>> -Additional setup is required since `sbuild` is now used for package build.
>> -Install the following packages:
>> +If your host is >= buster, also install the following package.
>>  ```
>> -apt install \
>> -  sbuild \
>> -  schroot
>> +apt install python3-distutils
>>  ```
>> -Also, user who runs isar should be added to `sbuild` group.
>>
>>  **NOTE:** sbuild version (<=0.78.1) packaged in Debian Buster doesn't support
>>  `$apt_keep_downloaded_packages` option which is required in Isar for
>>  populating `${DL_DIR}/deb`. So, host `sbuild` in this case should be manually
>>  upgraded to >=0.81.2 version from Debian Bullseye.
>>
>> +Next, the user who should run Isar needs to be added to `sbuild` group.
>>  ```
>>  sudo gpasswd -a <username> sbuild
>>  ```
>>
>> -If your host is >= buster, also install the following package.
>> -```
>> -apt install python3-distutils
>> -```
>> -
>>  If you want to generate containerized SDKs, also install the following
>>  packages: `umoci` and `skopeo`.
>>  Umoci is provided by Debian Buster and can be installed with
>> @@ -129,6 +122,11 @@ Notes:
>>    handled by QEMU (check e.g. `qemu-arm` in `/usr/sbin/update-binfmts
>>    --display`).
>>
>> +To run images built for QEMU, you also need to install the related package:
>> +```
>> +apt install qemu
>> +```
>> +
>>  ### Setup Sudo
>>
>>  Isar requires `sudo` rights without password to work with `chroot` and `debootstrap`. To add them, use the following steps:
>> --
>> 2.35.3
>>
> Hello Jan,
>
> How did you generate this patch?
> It looks like some endline whitespaces were missed in the end of the
> first chunk,
> so the patch became inapplicable.
>
> There is no need to resend this one, just wanted to warn for the future
> commits.
>

Sorry for the inconvenience. The local copy I have in my sent-box
applies fine but the one I also received via the list is indeed mangled.
I have no idea what went wrong.

Jan

Re: [PATCH] doc: Rework description of build dependencies installation

[Anton Mikanovich]

26.08.2022 12:03, Jan Kiszka wrote:
> From: Jan Kiszka <jan.kiszka@siemens.com>
>
> Fold in sbuild and schroot packages so that everything needed for
> building is in one list.
>
> Move qemu out of this list because it is only optional.
>
> Reorder the note about adding the user to the sbuild group so that it
> introduces the related command.
>
> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>

Applied to next, thanks.