public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
* [PATCH 0/3] Cover systemd.bbclass and devtool ide-sdk changes
@ 2024-12-24 14:02 Adrian Freihofer
  2024-12-24 14:02 ` [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2 Adrian Freihofer
                   ` (2 more replies)
  0 siblings, 3 replies; 8+ messages in thread
From: Adrian Freihofer @ 2024-12-24 14:02 UTC (permalink / raw)
  To: docs; +Cc: Adrian Freihofer

These 3 patches are based on today's master-next branch. Feel free to
squash "sdk-manual: extensible.rst: remove confusing
post-install-logging" into "Remove debug-tweaks references" if it is
still on master-next or keep it as a separate commit.

Adrian Freihofer (3):
  migration-guides: systemd.bbclass do not add Also services for 5.2
  sdk-manual: extensible.rst: update devtool ide-sdk
  sdk-manual: extensible.rst: remove confusing post-install-logging

 .../migration-guides/migration-5.2.rst        | 19 +++++++++++++++++++
 documentation/sdk-manual/extensible.rst       |  8 ++++----
 2 files changed, 23 insertions(+), 4 deletions(-)

-- 
2.47.1



^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2
  2024-12-24 14:02 [PATCH 0/3] Cover systemd.bbclass and devtool ide-sdk changes Adrian Freihofer
@ 2024-12-24 14:02 ` Adrian Freihofer
  2024-12-26  8:35   ` [docs] " Antonin Godard
  2025-01-13 16:09   ` Quentin Schulz
  2024-12-24 14:02 ` [PATCH 2/3] sdk-manual: extensible.rst: update devtool ide-sdk Adrian Freihofer
  2024-12-24 14:02 ` [PATCH 3/3] sdk-manual: extensible.rst: remove confusing post-install-logging Adrian Freihofer
  2 siblings, 2 replies; 8+ messages in thread
From: Adrian Freihofer @ 2024-12-24 14:02 UTC (permalink / raw)
  To: docs; +Cc: Adrian Freihofer

Covers the chagnes introduced by commit
https://git.yoctoproject.org/poky/commit/?id=efa5f65c2214239ed7aaf7bd8998683e755c5660

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
---
 .../migration-guides/migration-5.2.rst        | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
index cb70e19da..2ae8e73a7 100644
--- a/documentation/migration-guides/migration-5.2.rst
+++ b/documentation/migration-guides/migration-5.2.rst
@@ -74,6 +74,25 @@ systemd changes
    As a consequence, the ``systemd`` recipe no longer contains the ``usrmerge``
    :term:`PACKAGECONFIG` option as it is now implied by default.
 
+-  ``systemd.bbclass``: If a systemd service file had referred to other service
+   files by starting them as “Also”, the other service files were automatically added
+   to the ``FILES`` variable of the same package. Example: 
+
+   a.service contains:
+
+   .. code-block:: ini
+
+      [Install]
+      Also=b.service
+
+   If a.service is packed in package A, b.service is automatically packed
+   into package A as well. This happens even if b.service is explicitly
+   added to package B using FILES and SYSTEMD_SERVICE variables.
+
+   This prevents such services from being packaged into different packages.
+   Therefore, this automatic has been removed for service files (but not for socket files).
+   Now all service files must be explicitly added to ``FILES``.
+
 Recipe changes
 ~~~~~~~~~~~~~~
 
-- 
2.47.1



^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 2/3] sdk-manual: extensible.rst: update devtool ide-sdk
  2024-12-24 14:02 [PATCH 0/3] Cover systemd.bbclass and devtool ide-sdk changes Adrian Freihofer
  2024-12-24 14:02 ` [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2 Adrian Freihofer
@ 2024-12-24 14:02 ` Adrian Freihofer
  2024-12-26  8:35   ` [docs] " Antonin Godard
  2024-12-24 14:02 ` [PATCH 3/3] sdk-manual: extensible.rst: remove confusing post-install-logging Adrian Freihofer
  2 siblings, 1 reply; 8+ messages in thread
From: Adrian Freihofer @ 2024-12-24 14:02 UTC (permalink / raw)
  To: docs; +Cc: Adrian Freihofer

Replace
  devtool ide-sdk --debug-build-config
by
  devtool modify --debug-build

This change was introduced with commit
https://git.yoctoproject.org/poky/commit/?id=1f7eb26c947dde14698ae6e2ab88f0637027f4cb

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
---
 documentation/sdk-manual/extensible.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index 9a50d7fc5..3733997fa 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -669,7 +669,8 @@ The extensible SDK supports two different development modes.
       IMAGE_INSTALL:append = " my-recipe"
 
    Assuming the BitBake environment is set up correctly and a workspace has
-   been created for the recipe using ``devtool modify my-recipe``, the
+   been created for the recipe using ``devtool modify my-recipe`` or probably
+   even better by using ``devtool modify my-recipe --debug-build``, the
    following command can create the SDK and the configuration for VSCode in
    the recipe workspace::
 
@@ -786,8 +787,8 @@ The extensible SDK supports two different development modes.
    .. code-block:: sh
 
       # Create the SDK
-      devtool modify cmake-example
-      devtool ide-sdk cmake-example core-image-minimal -c --debug-build-config --ide=none
+      devtool modify cmake-example --debug-build
+      devtool ide-sdk cmake-example core-image-minimal -c --ide=none
 
       # Install the firmware on a target device or start QEMU
       runqemu
-- 
2.47.1



^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 3/3] sdk-manual: extensible.rst: remove confusing post-install-logging
  2024-12-24 14:02 [PATCH 0/3] Cover systemd.bbclass and devtool ide-sdk changes Adrian Freihofer
  2024-12-24 14:02 ` [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2 Adrian Freihofer
  2024-12-24 14:02 ` [PATCH 2/3] sdk-manual: extensible.rst: update devtool ide-sdk Adrian Freihofer
@ 2024-12-24 14:02 ` Adrian Freihofer
  2024-12-26  8:35   ` [docs] " Antonin Godard
  2 siblings, 1 reply; 8+ messages in thread
From: Adrian Freihofer @ 2024-12-24 14:02 UTC (permalink / raw)
  To: docs; +Cc: Adrian Freihofer

This is a fix for 22dc5b3be3b1fbdb9447999b71f79db055271826, which has
completely replaced debug-tweaks. But in the context of devtool ide-sdk
and the comment in the example, the post-install-logging-image feature
doesn't really make much sense. Therefore, remove it.

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
---
 documentation/sdk-manual/extensible.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index 3733997fa..1cb1bb47c 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -658,7 +658,6 @@ The extensible SDK supports two different development modes.
          allow-empty-password \
          allow-root-login \
          empty-root-password \
-         post-install-logging \
       "
 
       # Remote debugging needs gdbserver on the target device
-- 
2.47.1



^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2
  2024-12-24 14:02 ` [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2 Adrian Freihofer
@ 2024-12-26  8:35   ` Antonin Godard
  2025-01-13 16:09   ` Quentin Schulz
  1 sibling, 0 replies; 8+ messages in thread
From: Antonin Godard @ 2024-12-26  8:35 UTC (permalink / raw)
  To: adrian.freihofer, docs; +Cc: Adrian Freihofer

Hi Adrian,

Thanks for the update on this! Here below are some suggestions.

On Tue Dec 24, 2024 at 3:02 PM CET, Adrian Freihofer via lists.yoctoproject.org wrote:
> Covers the chagnes introduced by commit
> https://git.yoctoproject.org/poky/commit/?id=efa5f65c2214239ed7aaf7bd8998683e755c5660
>
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> ---
>  .../migration-guides/migration-5.2.rst        | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
>
> diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
> index cb70e19da..2ae8e73a7 100644
> --- a/documentation/migration-guides/migration-5.2.rst
> +++ b/documentation/migration-guides/migration-5.2.rst
> @@ -74,6 +74,25 @@ systemd changes
>     As a consequence, the ``systemd`` recipe no longer contains the ``usrmerge``
>     :term:`PACKAGECONFIG` option as it is now implied by default.
>  
> +-  ``systemd.bbclass``: If a systemd service file had referred to other service
> +   files by starting them as “Also”, the other service files were automatically added

s/by starting them as/with/?
s/“Also”/`Also <https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html#Also=>`__/?

> +   to the ``FILES`` variable of the same package. Example: 

s/``FILES``/:term:`FILES`/

Same for FILES and SYSTEMD_SERVICE below.

> +
> +   a.service contains:

Nitpick:

s/contains:/contains::/
and remove ".. code-block:: ini" below

> +
> +   .. code-block:: ini
> +
> +      [Install]
> +      Also=b.service
> +
> +   If a.service is packed in package A, b.service is automatically packed

s/packed/packaged/

> +   into package A as well. This happens even if b.service is explicitly
> +   added to package B using FILES and SYSTEMD_SERVICE variables.
> +
> +   This prevents such services from being packaged into different packages.
> +   Therefore, this automatic has been removed for service files (but not for socket files).

"automatic behavior"?

> +   Now all service files must be explicitly added to ``FILES``.
> +
>  Recipe changes
>  ~~~~~~~~~~~~~~
>  


Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 2/3] sdk-manual: extensible.rst: update devtool ide-sdk
  2024-12-24 14:02 ` [PATCH 2/3] sdk-manual: extensible.rst: update devtool ide-sdk Adrian Freihofer
@ 2024-12-26  8:35   ` Antonin Godard
  0 siblings, 0 replies; 8+ messages in thread
From: Antonin Godard @ 2024-12-26  8:35 UTC (permalink / raw)
  To: adrian.freihofer, docs; +Cc: Adrian Freihofer

On Tue Dec 24, 2024 at 3:02 PM CET, Adrian Freihofer via lists.yoctoproject.org wrote:
> Replace
>   devtool ide-sdk --debug-build-config
> by
>   devtool modify --debug-build
>
> This change was introduced with commit
> https://git.yoctoproject.org/poky/commit/?id=1f7eb26c947dde14698ae6e2ab88f0637027f4cb
>
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> ---
>  documentation/sdk-manual/extensible.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
> index 9a50d7fc5..3733997fa 100644
> --- a/documentation/sdk-manual/extensible.rst
> +++ b/documentation/sdk-manual/extensible.rst
> @@ -669,7 +669,8 @@ The extensible SDK supports two different development modes.
>        IMAGE_INSTALL:append = " my-recipe"
>  
>     Assuming the BitBake environment is set up correctly and a workspace has
> -   been created for the recipe using ``devtool modify my-recipe``, the
> +   been created for the recipe using ``devtool modify my-recipe`` or probably
> +   even better by using ``devtool modify my-recipe --debug-build``, the
>     following command can create the SDK and the configuration for VSCode in
>     the recipe workspace::
>  
> @@ -786,8 +787,8 @@ The extensible SDK supports two different development modes.
>     .. code-block:: sh
>  
>        # Create the SDK
> -      devtool modify cmake-example
> -      devtool ide-sdk cmake-example core-image-minimal -c --debug-build-config --ide=none
> +      devtool modify cmake-example --debug-build
> +      devtool ide-sdk cmake-example core-image-minimal -c --ide=none
>  
>        # Install the firmware on a target device or start QEMU
>        runqemu

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com



^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 3/3] sdk-manual: extensible.rst: remove confusing post-install-logging
  2024-12-24 14:02 ` [PATCH 3/3] sdk-manual: extensible.rst: remove confusing post-install-logging Adrian Freihofer
@ 2024-12-26  8:35   ` Antonin Godard
  0 siblings, 0 replies; 8+ messages in thread
From: Antonin Godard @ 2024-12-26  8:35 UTC (permalink / raw)
  To: adrian.freihofer, docs; +Cc: Adrian Freihofer

On Tue Dec 24, 2024 at 3:02 PM CET, Adrian Freihofer via lists.yoctoproject.org wrote:
> This is a fix for 22dc5b3be3b1fbdb9447999b71f79db055271826, which has
> completely replaced debug-tweaks. But in the context of devtool ide-sdk
> and the comment in the example, the post-install-logging-image feature
> doesn't really make much sense. Therefore, remove it.
>
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> ---
>  documentation/sdk-manual/extensible.rst | 1 -
>  1 file changed, 1 deletion(-)
>
> diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
> index 3733997fa..1cb1bb47c 100644
> --- a/documentation/sdk-manual/extensible.rst
> +++ b/documentation/sdk-manual/extensible.rst
> @@ -658,7 +658,6 @@ The extensible SDK supports two different development modes.
>           allow-empty-password \
>           allow-root-login \
>           empty-root-password \
> -         post-install-logging \
>        "
>  
>        # Remote debugging needs gdbserver on the target device

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com



^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [docs] [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2
  2024-12-24 14:02 ` [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2 Adrian Freihofer
  2024-12-26  8:35   ` [docs] " Antonin Godard
@ 2025-01-13 16:09   ` Quentin Schulz
  1 sibling, 0 replies; 8+ messages in thread
From: Quentin Schulz @ 2025-01-13 16:09 UTC (permalink / raw)
  To: adrian.freihofer, docs; +Cc: Adrian Freihofer

Hi Adrian,

On 12/24/24 3:02 PM, Adrian Freihofer via lists.yoctoproject.org wrote:
> Covers the chagnes introduced by commit
> https://git.yoctoproject.org/poky/commit/?id=efa5f65c2214239ed7aaf7bd8998683e755c5660
> 
> Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
> ---
>   .../migration-guides/migration-5.2.rst        | 19 +++++++++++++++++++
>   1 file changed, 19 insertions(+)
> 
> diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
> index cb70e19da..2ae8e73a7 100644
> --- a/documentation/migration-guides/migration-5.2.rst
> +++ b/documentation/migration-guides/migration-5.2.rst
> @@ -74,6 +74,25 @@ systemd changes
>      As a consequence, the ``systemd`` recipe no longer contains the ``usrmerge``
>      :term:`PACKAGECONFIG` option as it is now implied by default.
>   
> +-  ``systemd.bbclass``: If a systemd service file had referred to other service
> +   files by starting them as “Also”, the other service files were automatically added

Seems like those are not the doubles quotes we typically use (though 
there are a handful in the docs!). Maybe switch to " instead in the next 
version?

Cheers,
Quentin


^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2025-01-13 16:09 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-12-24 14:02 [PATCH 0/3] Cover systemd.bbclass and devtool ide-sdk changes Adrian Freihofer
2024-12-24 14:02 ` [PATCH 1/3] migration-guides: systemd.bbclass do not add Also services for 5.2 Adrian Freihofer
2024-12-26  8:35   ` [docs] " Antonin Godard
2025-01-13 16:09   ` Quentin Schulz
2024-12-24 14:02 ` [PATCH 2/3] sdk-manual: extensible.rst: update devtool ide-sdk Adrian Freihofer
2024-12-26  8:35   ` [docs] " Antonin Godard
2024-12-24 14:02 ` [PATCH 3/3] sdk-manual: extensible.rst: remove confusing post-install-logging Adrian Freihofer
2024-12-26  8:35   ` [docs] " Antonin Godard

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox