[PATCH 0/2] Improve release process section

[PATCH 0/2] Improve release process section

[Antonin Godard]

Following some discussion about the releases.svg file, timestamp the svg
with the month it was edited last, and refer to the release the doc was
built for using &DISTRO_NAME.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (2):
      ref-manual: release-process: update releases.svg with month after "Current"
      ref-manual: release-process: add a reference to the doc's release

 documentation/ref-manual/release-process.rst |  2 ++
 documentation/ref-manual/svg/releases.svg    | 18 +++++++++---------
 2 files changed, 11 insertions(+), 9 deletions(-)
---
base-commit: 4c81e2856c268d7d0221ebb6b8156ad65b9e83ca
change-id: 20241030-update-releases-svg-14641c6b0242

Best regards,
-- 
Antonin Godard <antonin.godard@bootlin.com>

[PATCH 1/2] ref-manual: release-process: update releases.svg with month after "Current"

[Antonin Godard]

This way we put a timestamp on the image, so that someone looking at the
image on an old release tarball has a representation of the release "as
of <date>".

Here set "Oct. 24" as it was the last time the file was updated.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/svg/releases.svg | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/documentation/ref-manual/svg/releases.svg b/documentation/ref-manual/svg/releases.svg
index b1036e066ceb65a7391cec616cb4304094728f3f..aad50cf593f56691d9961e427921af4ef25fdee2 100644
--- a/documentation/ref-manual/svg/releases.svg
+++ b/documentation/ref-manual/svg/releases.svg
@@ -409,14 +409,14 @@
      inkscape:pageopacity="0"
      inkscape:pageshadow="2"
      inkscape:window-width="3826"
-     inkscape:window-height="2049"
+     inkscape:window-height="2069"
      id="namedview4"
      showgrid="true"
-     inkscape:zoom="1.5536106"
-     inkscape:cx="868.94361"
-     inkscape:cy="273.87815"
-     inkscape:window-x="0"
-     inkscape:window-y="80"
+     inkscape:zoom="2.1971372"
+     inkscape:cx="1068.2082"
+     inkscape:cy="287.87461"
+     inkscape:window-x="2256"
+     inkscape:window-y="60"
      inkscape:window-maximized="1"
      inkscape:current-layer="g10"
      inkscape:document-rotation="0"
@@ -1494,14 +1494,14 @@
     <text
        xml:space="preserve"
        style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
-       x="1659.087"
+       x="1686.7159"
        y="-3.6722763"
        id="text1185-3-55-4-0-0-0-1-1-6-4-3-5-2-2"><tspan
          sodipodi:role="line"
-         x="1659.087"
+         x="1686.7159"
          y="-3.6722763"
          style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans';text-align:center;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none"
-         id="tspan10317-2-9-1-4-6-5-6-6-5-9-7">Current</tspan></text>
+         id="tspan10317-2-9-1-4-6-5-6-6-5-9-7">Current (Oct. 24)</tspan></text>
     <text
        xml:space="preserve"
        style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"

-- 
2.46.1

[PATCH 2/2] ref-manual: release-process: add a reference to the doc's release

[Antonin Godard]

When reading the stable releases section, we want to know for which
release the documentation was built. Use &DISTRO_NAME; to refer to the
current release.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/release-process.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index 75532addbdcd52cb0ab13ee8ffd57a70e1fc8045..691e7d3ed90c98e43e558809828b5094670ccca3 100644
--- a/documentation/ref-manual/release-process.rst
+++ b/documentation/ref-manual/release-process.rst
@@ -117,6 +117,8 @@ The currently supported :term:`LTS` releases are:
 See :yocto_wiki:`/Stable_Release_and_LTS` for details about the management
 of stable and :term:`LTS` releases.
 
+This documentation was built for the &DISTRO_NAME; release.
+
 .. image:: svg/releases.*
    :width: 100%
 

-- 
2.46.1

Re: [PATCH 0/2] Improve release process section

[Quentin Schulz]

Hi Antonin,

On 10/30/24 11:07 AM, Antonin Godard wrote:
> Following some discussion about the releases.svg file, timestamp the svg
> with the month it was edited last, and refer to the release the doc was
> built for using &DISTRO_NAME.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>

Good enough for now, maybe we'll come up with something better in the 
future.

For the whole series:
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin

Re: [PATCH 0/2] Improve release process section

[Antonin Godard]

Hi Quentin,

On Wed Oct 30, 2024 at 11:23 AM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 10/30/24 11:07 AM, Antonin Godard wrote:
>> Following some discussion about the releases.svg file, timestamp the svg
>> with the month it was edited last, and refer to the release the doc was
>> built for using &DISTRO_NAME.
>>
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>
> Good enough for now, maybe we'll come up with something better in the
> future.
>
> For the whole series:
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
>
> Thanks!
> Quentin

Thank you!
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com