diff mbox series

[4/4] poky.yaml.in: split automatic and manually replaced macros

Message ID 20251202-release-updates-v1-4-889513ccc384@bootlin.com
State Accepted
Headers show
Series Whinlatter release updates | expand

Commit Message

Antonin Godard Dec. 2, 2025, 4:14 p.m. UTC
Instead of thinking some of these macros should be replaced when a new
release is out, split the variable that should be manually maintained
and the ones that are automatically computed in set_versions.py.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/poky.yaml.in | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Quentin Schulz Dec. 3, 2025, 3:04 p.m. UTC | #1
Hi Antonin,

On 12/2/25 5:14 PM, Antonin Godard via lists.yoctoproject.org wrote:
> Instead of thinking some of these macros should be replaced when a new
> release is out, split the variable that should be manually maintained
> and the ones that are automatically computed in set_versions.py.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/poky.yaml.in | 11 +++++++++++
>   1 file changed, 11 insertions(+)
> 
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index 810efd4d5..f6d6ea9fc 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in
> @@ -2,6 +2,12 @@
>   # Macros used in the documentation
>   #
>   
> +#
> +# Automatically replaced by set_versions.py, no manual update required
> +# Values below are placeholders to give an idea on how to use them in the
> +# documentation.
> +#
> +
>   # The DISTRO variable represents the current docs version. It should be used
>   # when referring to the current docs version. See also DISTRO_LATEST_TAG.
>   DISTRO : "5.2"
> @@ -22,6 +28,11 @@ DISTRO_REL_TAG : "yocto-$DISTRO;"
>   DISTRO_REL_LATEST_TAG : "yocto-&DISTRO_LATEST_TAG;"
>   DOCCONF_VERSION : "dev"
>   BITBAKE_SERIES : ""

DISTRO_REL_TAG and DISTRO_REL_LATEST_TAG aren't actually replaced, so 
should we move them with the unchanged variables below?

Cheers,
Quentin
Antonin Godard Dec. 4, 2025, 1:21 p.m. UTC | #2
Hi,

On Wed Dec 3, 2025 at 4:04 PM CET, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Antonin,
>
> On 12/2/25 5:14 PM, Antonin Godard via lists.yoctoproject.org wrote:
>> Instead of thinking some of these macros should be replaced when a new
>> release is out, split the variable that should be manually maintained
>> and the ones that are automatically computed in set_versions.py.
>> 
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>>   documentation/poky.yaml.in | 11 +++++++++++
>>   1 file changed, 11 insertions(+)
>> 
>> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
>> index 810efd4d5..f6d6ea9fc 100644
>> --- a/documentation/poky.yaml.in
>> +++ b/documentation/poky.yaml.in
>> @@ -2,6 +2,12 @@
>>   # Macros used in the documentation
>>   #
>>   
>> +#
>> +# Automatically replaced by set_versions.py, no manual update required
>> +# Values below are placeholders to give an idea on how to use them in the
>> +# documentation.
>> +#
>> +
>>   # The DISTRO variable represents the current docs version. It should be used
>>   # when referring to the current docs version. See also DISTRO_LATEST_TAG.
>>   DISTRO : "5.2"
>> @@ -22,6 +28,11 @@ DISTRO_REL_TAG : "yocto-$DISTRO;"
>>   DISTRO_REL_LATEST_TAG : "yocto-&DISTRO_LATEST_TAG;"
>>   DOCCONF_VERSION : "dev"
>>   BITBAKE_SERIES : ""
>
> DISTRO_REL_TAG and DISTRO_REL_LATEST_TAG aren't actually replaced, so 
> should we move them with the unchanged variables below?

Ha, had a bit of hesitation for these ones, it's true they aren't replaced
although I doubt they're subject to change. Will move them anyhow, thanks.

Antonin
diff mbox series

Patch

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index 810efd4d5..f6d6ea9fc 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -2,6 +2,12 @@ 
 # Macros used in the documentation
 #
 
+#
+# Automatically replaced by set_versions.py, no manual update required
+# Values below are placeholders to give an idea on how to use them in the
+# documentation.
+#
+
 # The DISTRO variable represents the current docs version. It should be used
 # when referring to the current docs version. See also DISTRO_LATEST_TAG.
 DISTRO : "5.2"
@@ -22,6 +28,11 @@  DISTRO_REL_TAG : "yocto-$DISTRO;"
 DISTRO_REL_LATEST_TAG : "yocto-&DISTRO_LATEST_TAG;"
 DOCCONF_VERSION : "dev"
 BITBAKE_SERIES : ""
+
+#
+# Not automatically replaced, manual updates required
+#
+
 YOCTO_DL_URL : "https://downloads.yoctoproject.org"
 YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
 MIN_PYTHON_VERSION : "3.9.0"