Bug 13867

Summary: Reference to wrong release version used in the manual
Product: [Documentation] Reference Reporter: Nicolas Dechesne <ndec13>
Component: handbookAssignee: Armin Kuster <akuster>
Status: RESOLVED OBSOLETE QA Contact:
Severity: normal    
Priority: Medium+ CC: akuster808, poky.doc.watcher, poky.watcher, randy.macleod
Version: unspecified   
Target Milestone: 3.1.3   
Hardware: x86   
OS: Multiple   
Whiteboard: with backport
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Yes (doc changes required)

Description Nicolas Dechesne 2020-04-14 09:00:34 UTC
In the documentation source, we use DISTRO 'variable' to refer to the current distro, however in the section such as "Moving to the Yocto Project XX Release", this variable is used while it should not, since in such section we should have the actual XX version instead. 

As such we end up with the following bug on the document:

https://www.yoctoproject.org/docs/3.0.2/ref-manual/ref-manual.html#migration-2.3-scripts

e.g.
You must now supply a recipe for recipe as part of the command. Prior to the Yocto Project 3.0.1 release, it was not necessary to provide the script with the command. 

Because we use &DISTRO, it's replace with the value of DISTRO at the time the documentation is generated, instead of being what it is supposed to be (2.3 in this case).

There are probably many occurrences of this issue.
Comment 1 akuster 2020-06-01 09:50:51 UTC
I am a bit confused on what the issue it.

I see:

You must supply the name of the native recipe and the tool you want to run as part of the command. Prior to the Yocto Project 3.0.1 release, it was not necessary to provide the native recipe with the command. 

I don't see a problem with version.
Comment 2 Nicolas Dechesne 2020-06-01 09:59:51 UTC
the issue is that this doc section is about "4.11. Moving to the Yocto Project 2.3 Release". So this section was 'published' when 2.3 was released, and back then you wouldn't expect to have "Prior to the Yocto Project 3.0.1 release, it was not necessary to provide the native recipe with the command". 

Because we use &DISTRO in the corresponding XML, when we generate the doc *today* it says 3.0.1, but it should be set to 2.3. So we shouldn't be using &DISTRO but maybe something like &DISTR0-2.3 in this specific case. There are most likely many other similar situations.
Comment 3 akuster 2020-08-18 11:14:49 UTC
patch sent

https://patchwork.openembedded.org/patch/175439/
Comment 4 akuster 2020-09-28 19:46:15 UTC
this is obsolete.

we went to sphinx so I don't think its an issue anymore.