[PATCH] ref-manual: update references to release notes

[PATCH] ref-manual: update references to release notes

[michael.opdenacker]

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

Now part of the Yocto Project manual.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/ref-manual/resources.rst |  8 +++-----
 documentation/ref-manual/variables.rst | 10 ++++------
 2 files changed, 7 insertions(+), 11 deletions(-)

diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index fd4aed0164..06644363d5 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -171,11 +171,9 @@ Here is a list of resources you might find helpful:
 -  :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked
    questions and their answers.
 
--  Release Notes: Features, updates and known issues for the current
-   release of the Yocto Project. To access the Release Notes, go to the
-   :yocto_home:`Downloads </software-overview/downloads>` page on
-   the Yocto Project website and click on the "RELEASE INFORMATION" link
-   for the appropriate release.
+-  :yocto_docs:`Release Information </migration-guides/>`:
+   Migration guides, release notes, new features, updates and known issues
+   for the current and past releases of the Yocto Project.
 
 -  :yocto_bugs:`Bugzilla <>`: The bug tracking application
    the Yocto Project uses. If you find problems with the Yocto Project,
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0435f88347..776c8a2792 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8465,12 +8465,10 @@ system and gives an overview of their function and contents.
          If :term:`TCMODE` is set to a value other than "default", then it is your
          responsibility to ensure that the toolchain is compatible with the
          default toolchain. Using older or newer versions of these
-         components might cause build problems. See the Release Notes for
-         the Yocto Project release for the specific components with which
-         the toolchain must be compatible. To access the Release Notes, go
-         to the :yocto_home:`Downloads </software-overview/downloads>`
-         page on the Yocto Project website and click on the "RELEASE
-         INFORMATION" link for the appropriate release.
+         components might cause build problems. See
+         :yocto_docs:`Release Information </migration-guides/>` for your
+         version of the Yocto Project, to find the specific components with
+         which the toolchain must be compatible.
 
       The :term:`TCMODE` variable is similar to :term:`TCLIBC`,
       which controls the variant of the GNU standard C library (``libc``)
-- 
2.37.2

Re: [docs] [PATCH] ref-manual: update references to release notes

[Quentin Schulz]

Hi Michael,

On 12/8/22 16:16, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Now part of the Yocto Project manual.
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>   documentation/ref-manual/resources.rst |  8 +++-----
>   documentation/ref-manual/variables.rst | 10 ++++------
>   2 files changed, 7 insertions(+), 11 deletions(-)
> 
> diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
> index fd4aed0164..06644363d5 100644
> --- a/documentation/ref-manual/resources.rst
> +++ b/documentation/ref-manual/resources.rst
> @@ -171,11 +171,9 @@ Here is a list of resources you might find helpful:
>   -  :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked
>      questions and their answers.
>   
> --  Release Notes: Features, updates and known issues for the current
> -   release of the Yocto Project. To access the Release Notes, go to the
> -   :yocto_home:`Downloads </software-overview/downloads>` page on
> -   the Yocto Project website and click on the "RELEASE INFORMATION" link
> -   for the appropriate release.
> +-  :yocto_docs:`Release Information </migration-guides/>`:
> +   Migration guides, release notes, new features, updates and known issues
> +   for the current and past releases of the Yocto Project.
>   
>   -  :yocto_bugs:`Bugzilla <>`: The bug tracking application
>      the Yocto Project uses. If you find problems with the Yocto Project,
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 0435f88347..776c8a2792 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -8465,12 +8465,10 @@ system and gives an overview of their function and contents.
>            If :term:`TCMODE` is set to a value other than "default", then it is your
>            responsibility to ensure that the toolchain is compatible with the
>            default toolchain. Using older or newer versions of these
> -         components might cause build problems. See the Release Notes for
> -         the Yocto Project release for the specific components with which
> -         the toolchain must be compatible. To access the Release Notes, go
> -         to the :yocto_home:`Downloads </software-overview/downloads>`
> -         page on the Yocto Project website and click on the "RELEASE
> -         INFORMATION" link for the appropriate release.
> +         components might cause build problems. See
> +         :yocto_docs:`Release Information </migration-guides/>` for your
> +         version of the Yocto Project, to find the specific components with
> +         which the toolchain must be compatible.
>   

Where is this info located exactly?

Cheers,
Quentin

Re: [docs] [PATCH] ref-manual: update references to release notes

[Michael Opdenacker]

Hi Quentin,

Thanks for the review.

Am 09.12.22 um 11:05 schrieb Quentin Schulz via lists.yoctoproject.org:
> Hi Michael,
>
> On 12/8/22 16:16, Michael Opdenacker via lists.yoctoproject.org wrote:
>>
>> +         components might cause build problems. See
>> +         :yocto_docs:`Release Information </migration-guides/>` for 
>> your
>> +         version of the Yocto Project, to find the specific 
>> components with
>> +         which the toolchain must be compatible.
>
> Where is this info located exactly?

Well, information is scarce. In the release notes, you have at least the 
glibc version which is supported, and sometimes but not systematically 
the supported gcc and binutils versions.

Shall I say "where you may find the specific components..."?
Cheers
Michael.

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

Re: [docs] [PATCH] ref-manual: update references to release notes

[Quentin Schulz]

Hi Michael,

On 12/9/22 16:22, Michael Opdenacker wrote:
> Hi Quentin,
> 
> Thanks for the review.
> 
> Am 09.12.22 um 11:05 schrieb Quentin Schulz via lists.yoctoproject.org:
>> Hi Michael,
>>
>> On 12/8/22 16:16, Michael Opdenacker via lists.yoctoproject.org wrote:
>>>
>>> +         components might cause build problems. See
>>> +         :yocto_docs:`Release Information </migration-guides/>` for 
>>> your
>>> +         version of the Yocto Project, to find the specific 
>>> components with
>>> +         which the toolchain must be compatible.
>>
>> Where is this info located exactly?
> 
> Well, information is scarce. In the release notes, you have at least the 
> glibc version which is supported, and sometimes but not systematically 
> the supported gcc and binutils versions.
> 
> Shall I say "where you may find the specific components..."?

I'm just wondering how this would help people if there's no actual way 
of knowing the specific components or their version.

In the end, if there's not more information than the previous location, 
I guess the patch in itself is fine and another patch/workflow/process 
can be put in place to make this more helpful (if even possible).

Cheers,
Quentin

Re: [docs] [PATCH] ref-manual: update references to release notes

[Michael Opdenacker]

Am 09.12.22 um 17:38 schrieb Quentin Schulz via lists.yoctoproject.org:
> Hi Michael,
>
> On 12/9/22 16:22, Michael Opdenacker wrote:
>> Hi Quentin,
>>
>> Thanks for the review.
>>
>> Am 09.12.22 um 11:05 schrieb Quentin Schulz via lists.yoctoproject.org:
>>> Hi Michael,
>>>
>>> On 12/8/22 16:16, Michael Opdenacker via lists.yoctoproject.org wrote:
>>>>
>>>> +         components might cause build problems. See
>>>> +         :yocto_docs:`Release Information </migration-guides/>` 
>>>> for your
>>>> +         version of the Yocto Project, to find the specific 
>>>> components with
>>>> +         which the toolchain must be compatible.
>>>
>>> Where is this info located exactly?
>>
>> Well, information is scarce. In the release notes, you have at least 
>> the glibc version which is supported, and sometimes but not 
>> systematically the supported gcc and binutils versions.
>>
>> Shall I say "where you may find the specific components..."?
>
> I'm just wondering how this would help people if there's no actual way 
> of knowing the specific components or their version.
>
> In the end, if there's not more information than the previous 
> location, I guess the patch in itself is fine and another 
> patch/workflow/process can be put in place to make this more helpful 
> (if even possible).


Agreed. We can improve this in a future commit.
Cheers
Michael.

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