poky.yaml: Drop POKYVERSION and YOCTO_POKY references

Message ID 20220318120008.1061207-1-richard.purdie@linuxfoundation.org
State New
Headers show
Series poky.yaml: Drop POKYVERSION and YOCTO_POKY references | expand

Commit Message

Richard Purdie March 18, 2022, noon UTC
We don't publish tarballs using this version any more, it has been
removed everywhere. Remove the obsolete references in the docs,
adapting references accordingly. The tarballs now are just created
with their sha256 checksum which we don't want or need to reference
in the docs.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/dev-manual/start.rst                 |  4 +---
 .../overview-manual/development-environment.rst    |  2 +-
 documentation/poky.yaml                            |  2 --
 documentation/ref-manual/terms.rst                 | 14 +++++++-------
 4 files changed, 9 insertions(+), 13 deletions(-)

Comments

Michael Opdenacker March 18, 2022, 2:24 p.m. UTC | #1
Hi Richard,

On 3/18/22 13:00, Richard Purdie wrote:
> We don't publish tarballs using this version any more, it has been
> removed everywhere. Remove the obsolete references in the docs,
> adapting references accordingly. The tarballs now are just created
> with their sha256 checksum which we don't want or need to reference
> in the docs.


Thanks for the welcome simplification!
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into master-next.

Cheers
Michael.

Patch

diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 701d3cf4d..96fabac1a 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -647,9 +647,7 @@  Follow these steps to locate and download a particular tarball:
 
 3. *Find the Tarball:* Drill down to find the associated tarball. For
    example, click on ``yocto-&DISTRO;`` to view files associated with the
-   Yocto Project &DISTRO; release (e.g.
-   ``&YOCTO_POKY;.tar.bz2``, which is the
-   released Poky tarball).
+   Yocto Project &DISTRO; release.
 
 4. *Download the Tarball:* Click the tarball to download and save a
    snapshot of the given component.
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst
index fc193f313..9c9c8e87a 100644
--- a/documentation/overview-manual/development-environment.rst
+++ b/documentation/overview-manual/development-environment.rst
@@ -461,7 +461,7 @@  and clicking on the ``[...]`` link beneath the "Tag" heading.
 
 Some key tags for the ``poky`` repository are ``jethro-14.0.3``,
 ``morty-16.0.1``, ``pyro-17.0.0``, and
-``&DISTRO_NAME_NO_CAP;-&POKYVERSION;``. These tags represent Yocto Project
+``&DISTRO_NAME_NO_CAP;-&DISTRO;``. These tags represent Yocto Project
 releases.
 
 When you create a local copy of the Git repository, you also have access
diff --git a/documentation/poky.yaml b/documentation/poky.yaml
index 4f4f3e3a9..c8a890c40 100644
--- a/documentation/poky.yaml
+++ b/documentation/poky.yaml
@@ -6,8 +6,6 @@  DISTRO_NAME_NO_CAP_LTS : "dunfell"
 YOCTO_DOC_VERSION : "3.4.2"
 YOCTO_DOC_VERSION_MINUS_ONE : "3.3.5"
 DISTRO_REL_TAG : "yocto-3.4.2"
-POKYVERSION : "26.0.2"
-YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;"
 YOCTO_DL_URL : "https://downloads.yoctoproject.org"
 YOCTO_AB_URL : "https://autobuilder.yoctoproject.org"
 YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 3f18d3404..cba514c34 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -88,11 +88,11 @@  universal, the list includes them just in case:
          -  Provide a directory path and specifically name the Build
             Directory. Any intermediate folders in the pathname must exist.
             This next example creates a Build Directory named
-            ``YP-&POKYVERSION;`` within the existing directory ``mybuilds``:
+            ``YP-&DISTRO;`` within the existing directory ``mybuilds``:
 
             .. code-block:: shell
 
-               $ source poky/oe-init-build-env mybuilds/YP-&POKYVERSION;
+               $ source poky/oe-init-build-env mybuilds/YP-&DISTRO;
 
       .. note::
 
@@ -357,13 +357,13 @@  universal, the list includes them just in case:
      repository results in a local Git repository whose top-level folder
      is also named "poky".
 
-     While it is not recommended that you use tarball expansion to set up
+     While it is not recommended that you use tarball extraction to set up
      the Source Directory, if you do, the top-level directory name of the
      Source Directory is derived from the Yocto Project release tarball.
-     For example, downloading and unpacking
-     :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2`
-     results in a Source Directory whose root folder is named
-     ``&YOCTO_POKY;``.
+     For example, downloading and unpacking poky tarballs from
+     :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/`
+     results in a Source Directory whose root folder is named poky.
+
 
      It is important to understand the differences between the Source
      Directory created by unpacking a released tarball as compared to