[PATCH] manuals: final removal of SERIAL_CONSOLE variable

[PATCH] manuals: final removal of SERIAL_CONSOLE variable

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

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

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/migration-guides/migration-2.6.rst | 15 ++++++---------
 documentation/ref-manual/variables.rst           | 13 -------------
 2 files changed, 6 insertions(+), 22 deletions(-)

diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst
index 8e79a3edc9..356f720850 100644
--- a/documentation/migration-guides/migration-2.6.rst
+++ b/documentation/migration-guides/migration-2.6.rst
@@ -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:
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 499a26f50b..7717d6deff 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -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
-- 
2.37.2

Re: [docs] [PATCH] manuals: final removal of SERIAL_CONSOLE variable

[Quentin Schulz]

Hi Michael,

On 12/12/22 10:49, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> 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

Re: [docs] [PATCH] manuals: final removal of SERIAL_CONSOLE variable

[Michael Opdenacker]

Hi Quentin,

Am 12.12.22 um 11:22 schrieb Quentin Schulz via lists.yoctoproject.org:
> Hi Michael,
>
> On 12/12/22 10:49, Michael Opdenacker via lists.yoctoproject.org wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> 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.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH] manuals: final removal of SERIAL_CONSOLE variable

[Richard Purdie]

On Mon, 2022-12-12 at 11:26 +0100, Michael Opdenacker via
lists.yoctoproject.org wrote:
> Hi Quentin,
> 
> Am 12.12.22 um 11:22 schrieb Quentin Schulz via lists.yoctoproject.org:
> > Hi Michael,
> > 
> > On 12/12/22 10:49, Michael Opdenacker via lists.yoctoproject.org wrote:
> > > From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > > 
> > > 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!

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