[PATCH 0/2] Updates in the documentation

[PATCH 0/2] Updates in the documentation

[Uladzimir Bely]

Small polishes in the documentation files before upcoming
release v0.10.

If there are more things to update in the documentation files,
they can be added to new versions of this patchset.

Uladzimir Bely (2):
  doc/user_manual.md: Fix/update the contents
  image-account-extension: Move examples to user manual

 doc/user_manual.md                           | 32 ++++++++++++++++++--
 meta/classes/image-account-extension.bbclass | 18 -----------
 2 files changed, 30 insertions(+), 20 deletions(-)

-- 
2.20.1

[PATCH 1/2] doc/user_manual.md: Fix/update the contents

[Uladzimir Bely]

Add missing top-level sections of the contents and fix some
sections with broken links.

Signed-off-by: Uladzimir Bely <ubely@ilbers.de>
---
 doc/user_manual.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 2eb97647..27b86869 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -10,20 +10,26 @@ Copyright (C) 2016-2019, ilbers GmbH
  - [How Isar Works](#how-isar-works)
  - [General Isar Configuration](#general-isar-configuration)
  - [Isar Distro Configuration](#isar-distro-configuration)
- - [Custom Package Compilation](#custom-package-compilation-1)
+ - [Custom Package Generation](#custom-package-generation-1)
  - [Image Type Selection](#image-type-selection)
  - [Add a New Distro](#add-a-new-distro)
  - [Add a New Machine](#add-a-new-machine)
  - [Add a New Image](#add-a-new-image)
  - [Add a New Image Type](#add-a-new-image-type)
+ - [Customize and configure image](#customize-and-configure-image)
+ - [Create a Custom Image Recipe](#create-a-custom-image-recipe)
  - [Add a Custom Application](#add-a-custom-application)
  - [Build statistics collection](#build-statistics-collection)
- - [Enabling Cross-compilation](#isar-cross-compilation)
+ - [Isar Cross-compilation](#isar-cross-compilation)
+ - [Examining and debugging package generation inside their schroot rootfs](#examining-and-debugging-package-generation-inside-their-schroot-rootfs)
  - [Using ccache for custom packages](#using-ccache-for-custom-packages)
  - [Using sstate-cache](#using-sstate-cache)
  - [Create an ISAR SDK root filesystem](#create-an-isar-sdk-root-filesystem)
  - [Create a containerized Isar SDK root filesystem](#create-a-containerized-isar-sdk-root-filesystem)
  - [Creation of local apt repo caching upstream Debian packages](#creation-of-local-apt-repo-caching-upstream-debian-packages)
+ - [Add foreign packages from other repositories to the generated image](#add-foreign-packages-from-other-repositories-to-the-generated-image)
+ - [Cache all upstream Debian source packages in local apt](#cache-all-upstream-debian-source-packages-in-local-apt)
+ - [Use a custom sbuild chroot to speedup build](#use-a-custom-sbuild-chroot-to-speedup-build)
 
 
 ## Introduction
-- 
2.20.1

[PATCH 2/2] image-account-extension: Move examples to user manual

[Uladzimir Bely]

Based on discussion in https://github.com/ilbers/isar/issues/103

Signed-off-by: Uladzimir Bely <ubely@ilbers.de>
---
 doc/user_manual.md                           | 22 ++++++++++++++++++++
 meta/classes/image-account-extension.bbclass | 18 ----------------
 2 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/doc/user_manual.md b/doc/user_manual.md
index 27b86869..747b5ffe 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -700,6 +700,28 @@ The `USERS` and `USER:<username>` variable works similar to the `GROUPS` and `GR
    - `clear-text-password` - The `password` flag of the given user contains a clear-text password and not an encrypted version of it.
    - `force-passwd-change` - Force the user to change to password on first login.
 
+#### Example
+
+```
+GROUPS += "root"
+GROUP_root[gid] = "0"
+GROUP_root[flags] = "system"
+
+USERS += "root"
+USER_root[password] = "$6$rounds=10000$RXeWrnFmkY$DtuS/OmsAS2cCEDo0BF5qQsizIrq6jPgXnwv3PHqREJeKd1sXdHX/ayQtuQWVDHe0KIO0/sVH8dvQm1KthF0d/"
+USER_root[expire] = "180"
+USER_root[inactive] = "30"
+USER_root[uid] = "0"
+USER_root[gid] = "0"
+USER_root[comment] = "The ultimate root user"
+USER_root[home] = "/home/root"
+USER_root[shell] = "/bin/sh"
+USER_root[groups] = "audio video"
+USER_root[flags] = "create-home system force-passwd-change"
+```
+
+Some examples can be also found in `meta-isar/conf/local.conf.sample`.
+
 #### Home directory contents prefilling
 
 To cover all users simply use `/etc/skel`. Files in there will be available in every home directory under correct permissions.
diff --git a/meta/classes/image-account-extension.bbclass b/meta/classes/image-account-extension.bbclass
index 412aa06d..9e67cb91 100644
--- a/meta/classes/image-account-extension.bbclass
+++ b/meta/classes/image-account-extension.bbclass
@@ -6,26 +6,8 @@
 # This class extends the image.bbclass for creating user accounts and groups.
 
 USERS ??= ""
-
-#USERS += "root"
-#USER_root[password] = "" # Encrypted password, or clear-text when [flags] = "clear-text-password"
-#USER_root[expire] = ""
-#USER_root[inactive] = ""
-#USER_root[uid] = ""
-#USER_root[gid] = "" # If first character is a number: gid, otherwise groupname
-#USER_root[comment] = "The ultimate root user"
-#USER_root[home] = "/home/root"
-#USER_root[shell] = "/bin/sh"
-#USER_root[groups] = "audio video"
-#USER_root[flags] = "no-create-home create-home system allow-empty-password clear-text-password force-passwd-change"
-
 GROUPS ??= ""
 
-#GROUPS += "root"
-#GROUP_root[gid] = ""
-#GROUP_root[flags] = "system"
-
-
 def image_create_groups(d: "DataSmart") -> None:
     """Creates the groups defined in the ``GROUPS`` bitbake variable.
 
-- 
2.20.1

Re: [PATCH 0/2] Updates in the documentation

[Uladzimir Bely]

On Tue, 2024-01-30 at 11:15 +0100, Uladzimir Bely wrote:
> Small polishes in the documentation files before upcoming
> release v0.10.
> 
> If there are more things to update in the documentation files,
> they can be added to new versions of this patchset.
> 
> Uladzimir Bely (2):
>   doc/user_manual.md: Fix/update the contents
>   image-account-extension: Move examples to user manual
> 
>  doc/user_manual.md                           | 32
> ++++++++++++++++++--
>  meta/classes/image-account-extension.bbclass | 18 -----------
>  2 files changed, 30 insertions(+), 20 deletions(-)
> 
> -- 
> 2.20.1
> 
Applied to next.