Skip to contentSkip to conversation

manuals: final removal of SERIAL_CONSOLE variable

PATCH In review [email protected] 3 participants 4 messages Dec 12, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 manuals: final removal of SERIAL_CONSOLE variable

From: Michael Opdenacker <[email protected]>

This deprecated variable has been removed for good through
https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7

---
 documentation/migration-guides/migration-2.6.rst | 15 ++++++---------
 documentation/ref-manual/variables.rst           | 13 -------------
 2 files changed, 6 insertions(+), 22 deletions(-)
documentation/migration-guides/migration-2.6.rst +6 -9
index 8e79a3edc9..356f720850 100644
@@ -211,22 +211,19 @@ The following changes have been made:
 ``SERIAL_CONSOLE`` Deprecated
 -----------------------------
 
-The :term:`SERIAL_CONSOLE` variable has been
-functionally replaced by the
-:term:`SERIAL_CONSOLES` variable for some time.
-With the Yocto Project 2.6 release, :term:`SERIAL_CONSOLE` has been
-officially deprecated.
+The ``SERIAL_CONSOLE`` variable has been functionally replaced by the
+:term:`SERIAL_CONSOLES` variable for some time. With the Yocto Project 2.6
+release, ``SERIAL_CONSOLE`` has been officially deprecated.
 
-:term:`SERIAL_CONSOLE` will continue to work as before for the 2.6 release.
+``SERIAL_CONSOLE`` will continue to work as before for the 2.6 release.
 However, for the sake of future compatibility, it is recommended that
-you replace all instances of :term:`SERIAL_CONSOLE` with
-:term:`SERIAL_CONSOLES`.
+you replace all instances of ``SERIAL_CONSOLE`` with :term:`SERIAL_CONSOLES`.
 
 .. note::
 
    The only difference in usage is that :term:`SERIAL_CONSOLES`
    expects entries to be separated using semicolons as compared to
-   :term:`SERIAL_CONSOLE`, which expects spaces.
+   ``SERIAL_CONSOLE``, which expects spaces.
 
 .. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error:
 
documentation/ref-manual/variables.rst +0 -13
index 499a26f50b..7717d6deff 100644
@@ -7305,19 +7305,6 @@ system and gives an overview of their function and contents.
       :term:`FULL_OPTIMIZATION` unless :term:`DEBUG_BUILD` = "1", in which
       case the value of :term:`DEBUG_OPTIMIZATION` is used.
 
-   :term:`SERIAL_CONSOLE`
-      Defines a serial console (TTY) to enable using
-      `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a
-      value that specifies the baud rate followed by the TTY device name
-      separated by a space. You cannot specify more than one TTY device::
-
-         SERIAL_CONSOLE = "115200 ttyS0"
-
-      .. note::
-
-         The :term:`SERIAL_CONSOLE` variable is deprecated. Please use the
-         :term:`SERIAL_CONSOLES` variable.
-
    :term:`SERIAL_CONSOLES`
       Defines a serial console (TTY) to enable using
       `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a
Signature · 1 line
2.37.2
#1 lore raw

Hi Michael,

Quoted 5 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

This deprecated variable has been removed for good through
https://urldefense.com/v3/__https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7__;!!OOPJP91ZZw!mdIhsk9314XecKGpMxgc_65hSaYE2VoOo41x1ne13KiL-CTEfSgyidbnwYhCshdThpFx9pkMiUToxlsznioCpyDfYgQ641L54bUJg6MTpZwevFvYDYzv$

Should we start a migration manual for 4.2 that we update every now and then rather than a big change to review right before (or sometimes after :/) the release has been made?

I don't know exactly what's the workflow/process here, just asking.

Cheers,
Quentin

#2 lore raw

Hi Quentin,

Am 12.12.22 um 11:22 schrieb Quentin Schulz via lists.yoctoproject.org:

Quoted 5 lines

Hi Michael,

Quoted 2 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

Quoted 8 lines
Quoted 4 lines

This deprecated variable has been removed for good through
https://urldefense.com/v3/__https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7__;!!OOPJP91ZZw!mdIhsk9314XecKGpMxgc_65hSaYE2VoOo41x1ne13KiL-CTEfSgyidbnwYhCshdThpFx9pkMiUToxlsznioCpyDfYgQ641L54bUJg6MTpZwevFvYDYzv$

Should we start a migration manual for 4.2 that we update every now and then rather than a big change to review right before (or sometimes after :/) the release has been made?

I don't know exactly what's the workflow/process here, just asking.

Yes, we already started writing the migration notes ahead of time for the previous release. This sounds like a good time now for the next one. I'll submit a first draft that people will be able to contribute to.
Thanks for the reminder!

Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#3 lore raw
Quoted 17 lines · Michael Opdenacker via lists.yoctoproject.org

Hi Quentin,

Am 12.12.22 um 11:22 schrieb Quentin Schulz via lists.yoctoproject.org:

Quoted 14 lines

Hi Michael,

Quoted 6 lines · Michael Opdenacker via lists.yoctoproject.org

From: Michael Opdenacker <[email protected]>

This deprecated variable has been removed for good through
https://urldefense.com/v3/__https://git.openembedded.org/openembedded-core/commit/?id=9d053af1fb570b4e3483de4ecd6827e1e0be61b7__;!!OOPJP91ZZw!mdIhsk9314XecKGpMxgc_65hSaYE2VoOo41x1ne13KiL-CTEfSgyidbnwYhCshdThpFx9pkMiUToxlsznioCpyDfYgQ641L54bUJg6MTpZwevFvYDYzv$

Should we start a migration manual for 4.2 that we update every now and then rather than a big change to review right before (or sometimes after :/) the release has been made?

Quoted 7 lines
Quoted 1 line

I don't know exactly what's the workflow/process here, just asking.

Yes, we already started writing the migration notes ahead of time for the previous release. This sounds like a good time now for the next one. I'll submit a first draft that people will be able to contribute to. Thanks for the reminder!

We definitely should start one. In particular, we need to document the need to use the new "addpylib" directive in layer.conf files to enable lib directories within layers.

Cheers,

Richard