All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v2 0/6] Tidy up links in documentation
@ 2020-12-22  9:57 Paul Barker
  2020-12-22  9:57 ` [PATCH v2 1/6] documentation: Simplify oe_wiki and oe_home links Paul Barker
                   ` (5 more replies)
  0 siblings, 6 replies; 10+ messages in thread
From: Paul Barker @ 2020-12-22  9:57 UTC (permalink / raw)
  To: docs; +Cc: Paul Barker

Changes since v1:
  * Addess feedback from Quentin Schulz, many thanks for the review.

Paul Barker (6):
  documentation: Simplify oe_wiki and oe_home links
  documentation: Simplify layerindex and layer links
  documentation: Simplify remaining yocto_home links
  profile-manual: Simplify yocto_bugs link
  ref-manual: Simplify oe_lists link
  documentation: Use https links where possible

 documentation/README                          |  8 +--
 documentation/boilerplate.rst                 |  2 +-
 documentation/brief-yoctoprojectqs/index.rst  |  2 +-
 documentation/bsp-guide/bsp.rst               |  4 +-
 documentation/conf.py                         |  5 +-
 documentation/dev-manual/common-tasks.rst     | 17 +++----
 documentation/kernel-dev/intro.rst            |  3 +-
 documentation/overview-manual/concepts.rst    | 28 +++++------
 .../development-environment.rst               | 22 ++++-----
 documentation/overview-manual/yp-intro.rst    | 13 ++---
 documentation/profile-manual/usage.rst        | 49 +++++++++----------
 documentation/ref-manual/classes.rst          |  4 +-
 documentation/ref-manual/faq.rst              |  6 +--
 documentation/ref-manual/images.rst           |  4 +-
 documentation/ref-manual/kickstart.rst        |  4 +-
 documentation/ref-manual/migration-2.1.rst    |  2 +-
 documentation/ref-manual/migration-2.2.rst    |  4 +-
 documentation/ref-manual/migration-2.3.rst    |  4 +-
 documentation/ref-manual/migration-2.7.rst    |  2 +-
 documentation/ref-manual/qa-checks.rst        |  2 +-
 documentation/ref-manual/resources.rst        |  7 ++-
 documentation/ref-manual/variables.rst        | 20 ++++----
 documentation/sdk-manual/intro.rst            |  2 +-
 documentation/toaster-manual/intro.rst        |  2 +-
 documentation/toaster-manual/reference.rst    |  8 +--
 .../toaster-manual/setup-and-use.rst          | 11 ++---
 .../transitioning-to-a-custom-environment.rst |  4 +-
 documentation/what-i-wish-id-known.rst        | 11 ++---
 28 files changed, 119 insertions(+), 131 deletions(-)

-- 
2.26.2


^ permalink raw reply	[flat|nested] 10+ messages in thread

* [PATCH v2 1/6] documentation: Simplify oe_wiki and oe_home links
  2020-12-22  9:57 [PATCH v2 0/6] Tidy up links in documentation Paul Barker
@ 2020-12-22  9:57 ` Paul Barker
  2020-12-22  9:57 ` [PATCH v2 2/6] documentation: Simplify layerindex and layer links Paul Barker
                   ` (4 subsequent siblings)
  5 siblings, 0 replies; 10+ messages in thread
From: Paul Barker @ 2020-12-22  9:57 UTC (permalink / raw)
  To: docs; +Cc: Paul Barker

Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
 documentation/bsp-guide/bsp.rst            | 4 ++--
 documentation/conf.py                      | 1 +
 documentation/dev-manual/common-tasks.rst  | 2 +-
 documentation/kernel-dev/intro.rst         | 3 +--
 documentation/overview-manual/yp-intro.rst | 3 +--
 documentation/ref-manual/resources.rst     | 3 +--
 6 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 068ab6c80..93e918249 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -894,8 +894,8 @@ Yocto Project:
    ``recipes-*`` subdirectories specific to the recipe's function, or
    within a subdirectory containing a set of closely-related recipes.
    The recipes themselves should follow the general guidelines for
-   recipes used in the Yocto Project found in the "`OpenEmbedded Style
-   Guide <http://openembedded.org/wiki/Styleguide>`__".
+   recipes used in the Yocto Project found in the ":oe_wiki:`OpenEmbedded
+   Style Guide </Styleguide>`".
 
 -  *License File:* You must include a license file in the
    ``meta-bsp_root_name`` directory. This license covers the BSP
diff --git a/documentation/conf.py b/documentation/conf.py
index a626b1f14..b5351599d 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -79,6 +79,7 @@ extlinks = {
     'oe_home': ('https://www.openembedded.org%s', None),
     'oe_lists': ('https://lists.openembedded.org%s', None),
     'oe_git': ('https://git.openembedded.org%s', None),
+    'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
 }
 
 # Intersphinx config to use cross reference with Bitbake user manual
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index ada3bac7e..39db6563c 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -2540,7 +2540,7 @@ Following Recipe Style Guidelines
 ---------------------------------
 
 When writing recipes, it is good to conform to existing style
-guidelines. The :oe_home:`OpenEmbedded Styleguide </wiki/Styleguide>` wiki page
+guidelines. The :oe_wiki:`OpenEmbedded Styleguide </Styleguide>` wiki page
 provides rough guidelines for preferred recipe style.
 
 It is common for existing recipes to deviate a bit from this style.
diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst
index c95d2f7cb..f6c9b9713 100644
--- a/documentation/kernel-dev/intro.rst
+++ b/documentation/kernel-dev/intro.rst
@@ -72,8 +72,7 @@ tools with your own kernel sources.
 
 The remainder of this manual provides instructions for completing
 specific Linux kernel development tasks. These instructions assume you
-are comfortable working with
-`BitBake <https://openembedded.org/wiki/Bitbake>`__ recipes and basic
+are comfortable working with :oe_wiki:`BitBake </Bitbake>` recipes and basic
 open-source development tools. Understanding these concepts will
 facilitate the process of working with the kernel recipes. If you find
 you need some additional background, please be sure to review and
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 66a88c952..456bfc549 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -531,8 +531,7 @@ targets:
    Debian Package (dpkg) in operation.
 
    Opkg is intended for use on embedded Linux devices and is used in
-   this capacity in the
-   `OpenEmbedded <http://www.openembedded.org/wiki/Main_Page>`__ and
+   this capacity in the :oe_home:`OpenEmbedded <>` and
    `OpenWrt <https://openwrt.org/>`__ projects, as well as the Yocto
    Project.
 
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 77c367809..2c49c4e87 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -118,8 +118,7 @@ Here is a list of resources you might find helpful:
    distribution from which the Yocto Project derives its build system
    (Poky) and to which it contributes.
 
--  :oe_home:`BitBake </wiki/BitBake>`\ *:* The tool
-   used to process metadata.
+-  :oe_wiki:`BitBake </BitBake>`\ *:* The tool used to process metadata.
 
 -  :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
    guide to the BitBake tool. If you want information on BitBake, see
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH v2 2/6] documentation: Simplify layerindex and layer links
  2020-12-22  9:57 [PATCH v2 0/6] Tidy up links in documentation Paul Barker
  2020-12-22  9:57 ` [PATCH v2 1/6] documentation: Simplify oe_wiki and oe_home links Paul Barker
@ 2020-12-22  9:57 ` Paul Barker
  2020-12-22 14:19   ` [docs] " Quentin Schulz
  2020-12-22  9:57 ` [PATCH v2 3/6] documentation: Simplify remaining yocto_home links Paul Barker
                   ` (3 subsequent siblings)
  5 siblings, 1 reply; 10+ messages in thread
From: Paul Barker @ 2020-12-22  9:57 UTC (permalink / raw)
  To: docs; +Cc: Paul Barker

Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
 documentation/conf.py                             |  2 ++
 documentation/dev-manual/common-tasks.rst         |  9 ++++-----
 documentation/overview-manual/concepts.rst        | 15 ++++++---------
 documentation/overview-manual/yp-intro.rst        |  6 ++----
 documentation/ref-manual/migration-2.3.rst        |  2 +-
 documentation/toaster-manual/intro.rst            |  2 +-
 documentation/toaster-manual/reference.rst        |  4 ++--
 documentation/toaster-manual/setup-and-use.rst    | 11 +++++------
 .../transitioning-to-a-custom-environment.rst     |  4 ++--
 documentation/what-i-wish-id-known.rst            | 11 +++++------
 10 files changed, 30 insertions(+), 36 deletions(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index b5351599d..68eb92b0a 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -80,6 +80,8 @@ extlinks = {
     'oe_lists': ('https://lists.openembedded.org%s', None),
     'oe_git': ('https://git.openembedded.org%s', None),
     'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
+    'oe_layerindex': ('https://layers.openembedded.org%s', None),
+    'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
 }
 
 # Intersphinx config to use cross reference with Bitbake user manual
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 39db6563c..b2f433e1d 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -38,9 +38,8 @@ Follow these general steps to create your layer without using tools:
 
 1. *Check Existing Layers:* Before creating a new layer, you should be
    sure someone has not already created a layer containing the Metadata
-   you need. You can see the `OpenEmbedded Metadata
-   Index <https://layers.openembedded.org/layerindex/layers/>`__ for a
-   list of layers from the OpenEmbedded community that can be used in
+   you need. You can see the :oe_layer:`OpenEmbedded Metadata Index <>`
+   for a list of layers from the OpenEmbedded community that can be used in
    the Yocto Project. You could find a layer that is identical or close
    to what you need.
 
@@ -1194,8 +1193,8 @@ Before writing a recipe from scratch, it is often useful to discover
 whether someone else has already written one that meets (or comes close
 to meeting) your needs. The Yocto Project and OpenEmbedded communities
 maintain many recipes that might be candidates for what you are doing.
-You can find a good central index of these recipes in the `OpenEmbedded
-Layer Index <https://layers.openembedded.org>`__.
+You can find a good central index of these recipes in the
+:oe_layerindex:`OpenEmbedded Layer Index <>`.
 
 Working from an existing recipe or a skeleton recipe is the best way to
 get started. Here are some points on both methods:
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 8fbbabbac..98c7b4f6b 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -144,8 +144,7 @@ several pieces of hardware.
 Many layers exist that work in the Yocto Project development
 environment. The `Yocto Project Curated Layer
 Index <https://www.yoctoproject.org/software-overview/layers/>`__
-and `OpenEmbedded Layer
-Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__
+and :oe_layer:`OpenEmbedded Layer Index <>`
 both contain layers from which you can use or leverage.
 
 By convention, layers in the Yocto Project follow a specific form.
@@ -380,13 +379,11 @@ figure <#general-workflow-figure>`__:
 
 -  *Metadata (.bb + Patches):* Software layers containing
    user-supplied recipe files, patches, and append files. A good example
-   of a software layer might be the
-   `meta-qt5 layer <https://github.com/meta-qt5/meta-qt5>`__ from
-   the `OpenEmbedded Layer
-   Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
-   This layer is for version 5.0 of the popular
-   `Qt <https://wiki.qt.io/About_Qt>`__ cross-platform application
-   development framework for desktop, embedded and mobile.
+   of a software layer might be the :oe_layer:`meta-qt5 layer </meta-qt5/>`
+   from the :oe_layerindex:`OpenEmbedded Layer Index <>`. This layer is for
+   version 5.0 of the popular `Qt <https://wiki.qt.io/About_Qt>`__
+   cross-platform application development framework for desktop, embedded and
+   mobile.
 
 -  *Machine BSP Configuration:* Board Support Package (BSP) layers (i.e.
    "BSP Layer" in the following figure) providing machine-specific
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 456bfc549..980bfe5c2 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -221,8 +221,7 @@ your Metadata, the easier it is to cope with future changes.
 
    -  Familiarize yourself with the `Yocto Project curated layer
       index <https://www.yoctoproject.org/software-overview/layers/>`__
-      or the `OpenEmbedded layer
-      index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
+      or the :oe_layer:`OpenEmbedded layer index <>`.
       The latter contains more layers but they are less universally
       validated.
 
@@ -364,8 +363,7 @@ activities using the Yocto Project:
    versions available for Yocto Project. The main purpose of the system
    is to help you manage the recipes you maintain and to offer a dynamic
    overview of the project. The Recipe Reporting System is built on top
-   of the `OpenEmbedded Layer
-   Index <http://layers.openembedded.org/layerindex/layers/>`__, which
+   of the :oe_layerindex:`OpenEmbedded Layer Index <>`, which
    is a website that indexes OpenEmbedded-Core layers.
 
 -  *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
index 3e9758119..57ff011e7 100644
--- a/documentation/ref-manual/migration-2.3.rst
+++ b/documentation/ref-manual/migration-2.3.rst
@@ -238,7 +238,7 @@ to substitute a GPLv2 version of a GPLv3 recipe, then you must add the
 .. note::
 
    You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at
-   https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/.
+   :oe_layer:`/meta-gplv2/`.
 
 These relocated GPLv2 recipes do not receive the same level of
 maintenance as other core recipes. The recipes do not get security fixes
diff --git a/documentation/toaster-manual/intro.rst b/documentation/toaster-manual/intro.rst
index c78b3f53d..57e5b2bb7 100644
--- a/documentation/toaster-manual/intro.rst
+++ b/documentation/toaster-manual/intro.rst
@@ -27,7 +27,7 @@ extensive information about the build process.
    -  Browse layers listed in the various
       :ref:`layer sources <toaster-manual/reference:layer source>`
       that are available in your project (e.g. the OpenEmbedded Layer Index at
-      http://layers.openembedded.org/layerindex/).
+      :oe_layerindex:`/`).
 
    -  Browse images, recipes, and machines provided by those layers.
 
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index dfe51889e..34a1f39cf 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -24,7 +24,7 @@ type of layer source called a "layer index."
 A layer index is a web application that contains information about a set
 of custom layers. A good example of an existing layer index is the
 OpenEmbedded Layer Index. A public instance of this layer index exists
-at http://layers.openembedded.org. You can find the code for this
+at :oe_layerindex:`/`. You can find the code for this
 layer index's web application at :yocto_git:`/layerindex-web/`.
 
 When you tie a layer source into Toaster, it can query the layer source
@@ -81,7 +81,7 @@ describes two methods by which you can configure and use your layer
 index.
 
 In the previous section, the code for the OpenEmbedded Metadata Index
-(i.e. http://layers.openembedded.org) was referenced. You can use
+(i.e. :oe_layerindex:`/`) was referenced. You can use
 this code, which is at :yocto_git:`/layerindex-web/`, as a base to create
 your own layer index.
 
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst
index 2cb7884eb..a3225da91 100644
--- a/documentation/toaster-manual/setup-and-use.rst
+++ b/documentation/toaster-manual/setup-and-use.rst
@@ -462,9 +462,8 @@ Using the Toaster Web Interface
 
 The Toaster web interface allows you to do the following:
 
--  Browse published layers in the `OpenEmbedded Layer
-   Index <http://layers.openembedded.org>`__ that are available for your
-   selected version of the build system.
+-  Browse published layers in the :oe_layer:`OpenEmbedded Layer Index <>`
+   that are available for your selected version of the build system.
 
 -  Import your own layers for building.
 
@@ -573,11 +572,11 @@ However, the "Local Yocto Project" release will not provide you with any
 compatible layers, other than the three core layers that come with the
 Yocto Project:
 
--  `openembedded-core <http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/>`__
+-  :oe_layer:`openembedded-core </openembedded-core/>`
 
--  `meta-poky <http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/>`__
+-  :oe_layer:`meta-poky </meta-poky/>`
 
--  `meta-yocto-bsp <http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/>`__
+-  :oe_layer:`meta-yocto-bsp </meta-yocto-bsp/>`
 
 .. image:: figures/compatible-layers.png
    :align: center
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst
index 415f295b3..76a3215de 100644
--- a/documentation/transitioning-to-a-custom-environment.rst
+++ b/documentation/transitioning-to-a-custom-environment.rst
@@ -29,8 +29,8 @@ Transitioning to a custom environment for systems development
 
 #. **Find and acquire the best BSP for your target**.
    Use the :yocto_home:`Yocto Project curated layer index
-   </software-overview/layers/>` or even the `OpenEmbedded layer index
-   <https://layers.openembedded.org>`_ to find and acquire the best BSP for your
+   </software-overview/layers/>` or even the :oe_layer:`OpenEmbedded
+   layer index <>` to find and acquire the best BSP for your
    target board. The Yocto Project layer index BSPs are regularly validated. The
    best place to get your first BSP is from your silicon manufacturer or board
    vendor – they can point you to their most qualified efforts. In general, for
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
index a051036bb..a52a16656 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -27,11 +27,10 @@ contact us with other suggestions.
    to be responsible for your own updates.
 
 #. **Get to know the layer index:**
-   All layers can be found in the `layer index
-   <https://layers.openembedded.org/>`_. Layers which have applied for Yocto
-   Project Compatible status (structure continuity assurance and testing) can be
-   found in the :yocto_home:`Yocto Project Compatible index
-   </software-over/layer/>`.  Generally check the Compatible layer index first,
+   All layers can be found in the :oe_layer:`layer index <>`. Layers which
+   have applied for Yocto Project Compatible status (structure continuity
+   assurance and testing) can be found in the :yocto_home:`Yocto Project Compatible index
+   </software-over/layer/>`. Generally check the Compatible layer index first,
    and if you don't find the necessary layer check the general layer index. The
    layer index is an original artifact from the Open Embedded Project. As such,
    that index doesn't have the curating and testing that the Yocto Project
@@ -172,7 +171,7 @@ contact us with other suggestions.
    * add an ssh server to an image (enable transferring of files to target)
    * know the anatomy of a recipe
    * know how to create and use layers
-   * find recipes (with the `OpenEmbedded Layer index <https://layers.openembedded.org>`_)
+   * find recipes (with the :oe_layerindex:`OpenEmbedded Layer index <>`)
    * understand difference between machine and distro settings
    * find and use the right BSP (machine) for your hardware
    * find examples of distro features and know where to set them
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH v2 3/6] documentation: Simplify remaining yocto_home links
  2020-12-22  9:57 [PATCH v2 0/6] Tidy up links in documentation Paul Barker
  2020-12-22  9:57 ` [PATCH v2 1/6] documentation: Simplify oe_wiki and oe_home links Paul Barker
  2020-12-22  9:57 ` [PATCH v2 2/6] documentation: Simplify layerindex and layer links Paul Barker
@ 2020-12-22  9:57 ` Paul Barker
  2020-12-22  9:57 ` [PATCH v2 4/6] profile-manual: Simplify yocto_bugs link Paul Barker
                   ` (2 subsequent siblings)
  5 siblings, 0 replies; 10+ messages in thread
From: Paul Barker @ 2020-12-22  9:57 UTC (permalink / raw)
  To: docs; +Cc: Paul Barker

Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
 documentation/conf.py                      |  2 +-
 documentation/dev-manual/common-tasks.rst  |  4 ++--
 documentation/overview-manual/concepts.rst | 15 ++++++---------
 3 files changed, 9 insertions(+), 12 deletions(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index 68eb92b0a..407ea3292 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -68,7 +68,7 @@ rst_prolog = """
 
 # external links and substitutions
 extlinks = {
-    'yocto_home': ('https://yoctoproject.org%s', None),
+    'yocto_home': ('https://www.yoctoproject.org%s', None),
     'yocto_wiki': ('https://wiki.yoctoproject.org/wiki%s', None),
     'yocto_dl': ('https://downloads.yoctoproject.org%s', None),
     'yocto_lists': ('https://lists.yoctoproject.org%s', None),
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index b2f433e1d..bd8ceedc7 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -321,7 +321,7 @@ Logo for your layer and application. The process consists of two parts:
    successful compatibility registration.
 
 2. Completion of an application acceptance form, which you can find at
-   https://www.yoctoproject.org/webform/yocto-project-compatible-registration.
+   :yocto_home:`/webform/yocto-project-compatible-registration`.
 
 To be granted permission to use the logo, you need to satisfy the
 following:
@@ -345,7 +345,7 @@ application, you can use the Yocto Project Compatibility Logo with your
 layer and the application that uses your layer.
 
 To access the form, use this link:
-https://www.yoctoproject.org/webform/yocto-project-compatible-registration.
+:yocto_home:`/webform/yocto-project-compatible-registration`.
 Follow the instructions on the form to complete your application.
 
 The application consists of the following sections:
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 98c7b4f6b..916412e2c 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -141,11 +141,10 @@ hardware-specific configurations allows you to share other metadata by
 using a different layer where that metadata might be common across
 several pieces of hardware.
 
-Many layers exist that work in the Yocto Project development
-environment. The `Yocto Project Curated Layer
-Index <https://www.yoctoproject.org/software-overview/layers/>`__
-and :oe_layer:`OpenEmbedded Layer Index <>`
-both contain layers from which you can use or leverage.
+Many layers exist that work in the Yocto Project development environment. The
+:yocto_home:`Yocto Project Curated Layer Index </software-overview/layers/>`
+and :oe_layer:`OpenEmbedded Layer Index <>` both contain layers from
+which you can use or leverage.
 
 By convention, layers in the Yocto Project follow a specific form.
 Conforming to a known structure allows BitBake to make assumptions
@@ -2093,10 +2092,8 @@ The capability to run tasks in a fake root environment is known as
 the BitBake keyword/variable flag that requests a fake root environment
 for a task.
 
-In the :term:`OpenEmbedded Build System`,
-the program that
-implements fakeroot is known as
-`Pseudo <https://www.yoctoproject.org/software-item/pseudo/>`__. Pseudo
+In the :term:`OpenEmbedded Build System`, the program that implements
+fakeroot is known as :yocto_home:`Pseudo </software-item/pseudo/>`. Pseudo
 overrides system calls by using the environment variable ``LD_PRELOAD``,
 which results in the illusion of running as root. To keep track of
 "fake" file ownership and permissions resulting from operations that
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH v2 4/6] profile-manual: Simplify yocto_bugs link
  2020-12-22  9:57 [PATCH v2 0/6] Tidy up links in documentation Paul Barker
                   ` (2 preceding siblings ...)
  2020-12-22  9:57 ` [PATCH v2 3/6] documentation: Simplify remaining yocto_home links Paul Barker
@ 2020-12-22  9:57 ` Paul Barker
  2020-12-22  9:57 ` [PATCH v2 5/6] ref-manual: Simplify oe_lists link Paul Barker
  2020-12-22  9:57 ` [PATCH v2 6/6] documentation: Use https links where possible Paul Barker
  5 siblings, 0 replies; 10+ messages in thread
From: Paul Barker @ 2020-12-22  9:57 UTC (permalink / raw)
  To: docs; +Cc: Paul Barker

Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
 documentation/profile-manual/usage.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index 418f4e993..0da408443 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -1159,9 +1159,8 @@ e.g. 'perf help' or 'perf help record'.
 
 However, by default Yocto doesn't install man pages, but perf invokes
 the man pages for most help functionality. This is a bug and is being
-addressed by a Yocto bug: `Bug 3388 - perf: enable man pages for basic
-'help'
-functionality <https://bugzilla.yoctoproject.org/show_bug.cgi?id=3388>`__.
+addressed by a Yocto bug: :yocto_bugs:`Bug 3388 - perf: enable man pages for
+basic 'help' functionality </show_bug.cgi?id=3388>`.
 
 The man pages in text form, along with some other files, such as a set
 of examples, can be found in the 'perf' directory of the kernel tree: ::
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH v2 5/6] ref-manual: Simplify oe_lists link
  2020-12-22  9:57 [PATCH v2 0/6] Tidy up links in documentation Paul Barker
                   ` (3 preceding siblings ...)
  2020-12-22  9:57 ` [PATCH v2 4/6] profile-manual: Simplify yocto_bugs link Paul Barker
@ 2020-12-22  9:57 ` Paul Barker
  2020-12-22  9:57 ` [PATCH v2 6/6] documentation: Use https links where possible Paul Barker
  5 siblings, 0 replies; 10+ messages in thread
From: Paul Barker @ 2020-12-22  9:57 UTC (permalink / raw)
  To: docs; +Cc: Paul Barker

Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
 documentation/ref-manual/migration-2.2.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/documentation/ref-manual/migration-2.2.rst b/documentation/ref-manual/migration-2.2.rst
index ac247dce4..5c6fecf32 100644
--- a/documentation/ref-manual/migration-2.2.rst
+++ b/documentation/ref-manual/migration-2.2.rst
@@ -28,8 +28,8 @@ The way directories are staged in sysroot has been simplified and
 introduces the new :term:`SYSROOT_DIRS`,
 :term:`SYSROOT_DIRS_NATIVE`, and
 :term:`SYSROOT_DIRS_BLACKLIST`. See the
-`v2 patch series on the OE-Core Mailing
-List <http://lists.openembedded.org/pipermail/openembedded-core/2016-May/121365.html>`__
+:oe_lists:`v2 patch series on the OE-Core Mailing List
+</pipermail/openembedded-core/2016-May/121365.html>`
 for additional information.
 
 .. _migration-2.2-removal-of-old-images-from-tmp-deploy-now-enabled:
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* [PATCH v2 6/6] documentation: Use https links where possible
  2020-12-22  9:57 [PATCH v2 0/6] Tidy up links in documentation Paul Barker
                   ` (4 preceding siblings ...)
  2020-12-22  9:57 ` [PATCH v2 5/6] ref-manual: Simplify oe_lists link Paul Barker
@ 2020-12-22  9:57 ` Paul Barker
  5 siblings, 0 replies; 10+ messages in thread
From: Paul Barker @ 2020-12-22  9:57 UTC (permalink / raw)
  To: docs; +Cc: Paul Barker

Signed-off-by: Paul Barker <pbarker@konsulko.com>
---
 documentation/README                          |  8 ++--
 documentation/boilerplate.rst                 |  2 +-
 documentation/brief-yoctoprojectqs/index.rst  |  2 +-
 documentation/dev-manual/common-tasks.rst     |  2 +-
 .../development-environment.rst               | 22 +++++-----
 documentation/overview-manual/yp-intro.rst    |  4 +-
 documentation/profile-manual/usage.rst        | 44 +++++++++----------
 documentation/ref-manual/classes.rst          |  4 +-
 documentation/ref-manual/faq.rst              |  6 +--
 documentation/ref-manual/images.rst           |  4 +-
 documentation/ref-manual/kickstart.rst        |  4 +-
 documentation/ref-manual/migration-2.1.rst    |  2 +-
 documentation/ref-manual/migration-2.3.rst    |  2 +-
 documentation/ref-manual/migration-2.7.rst    |  2 +-
 documentation/ref-manual/qa-checks.rst        |  2 +-
 documentation/ref-manual/resources.rst        |  4 +-
 documentation/ref-manual/variables.rst        | 20 ++++-----
 documentation/sdk-manual/intro.rst            |  2 +-
 documentation/toaster-manual/reference.rst    |  4 +-
 19 files changed, 70 insertions(+), 70 deletions(-)

diff --git a/documentation/README b/documentation/README
index b0a3cb1dc..be03bb119 100644
--- a/documentation/README
+++ b/documentation/README
@@ -2,7 +2,7 @@ documentation
 =============
 
 This is the directory that contains the Yocto Project documentation.  The Yocto
-Project source repositories at http://git.yoctoproject.org/cgit.cgi have two
+Project source repositories at https://git.yoctoproject.org/cgit.cgi have two
 instances of the "documentation" directory.  You should understand each of
 these instances.
 
@@ -47,12 +47,12 @@ Folders exist for individual manuals as follows:
 Each folder is self-contained regarding content and figures.
 
 If you want to find HTML versions of the Yocto Project manuals on the web,
-go to http://www.yoctoproject.org and click on the "Documentation" tab.  From
+go to https://www.yoctoproject.org and click on the "Documentation" tab.  From
 there you have access to archived documentation from previous releases, current
 documentation for the latest release, and "Docs in Progress" for the release
 currently being developed.
 
-In general, the Yocto Project site (http://www.yoctoproject.org) is a great
+In general, the Yocto Project site (https://www.yoctoproject.org) is a great
 reference for both information and downloads.
 
 poky.yaml
@@ -228,7 +228,7 @@ content:
 
 Variables can be nested, like it was the case for DocBook:
 
-  YOCTO_HOME_URL : "http://www.yoctoproject.org"
+  YOCTO_HOME_URL : "https://www.yoctoproject.org"
   YOCTO_DOCS_URL : "&YOCTO_HOME_URL;/docs"
 
 Note directive
diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst
index ddffdac24..2ad60eb8b 100644
--- a/documentation/boilerplate.rst
+++ b/documentation/boilerplate.rst
@@ -8,7 +8,7 @@
 
 Permission is granted to copy, distribute and/or modify this document under the
 terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales
-<http://creativecommons.org/licenses/by-sa/2.0/uk/>`_ as published by Creative
+<https://creativecommons.org/licenses/by-sa/2.0/uk/>`_ as published by Creative
 Commons.
 
 To report any inaccuracies or problems with this (or any other Yocto Project)
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index f077ee843..63083cb13 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -397,7 +397,7 @@ information including the website, wiki pages, and user manuals:
    Development Community into which you can tap.
 
 -  **Developer Screencast:** The `Getting Started with the Yocto Project -
-   New Developer Screencast Tutorial <http://vimeo.com/36450321>`__
+   New Developer Screencast Tutorial <https://vimeo.com/36450321>`__
    provides a 30-minute video created for users unfamiliar with the
    Yocto Project but familiar with Linux build hosts. While this
    screencast is somewhat dated, the introductory and fundamental
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index bd8ceedc7..67dc7d820 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -6043,7 +6043,7 @@ the Internet:
    Botnet
 
 -  *"*\ `Security Issues for Embedded
-   Devices <http://elinux.org/images/6/6f/Security-issues.pdf>`__\ *"*
+   Devices <https://elinux.org/images/6/6f/Security-issues.pdf>`__\ *"*
    by Jake Edge
 
 When securing your image is of concern, there are steps, tools, and
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst
index 9a2997d9f..011a47957 100644
--- a/documentation/overview-manual/development-environment.rst
+++ b/documentation/overview-manual/development-environment.rst
@@ -40,7 +40,7 @@ project is the Windows family of operating systems developed by
 Microsoft Corporation.
 
 Wikipedia has a good historical description of the Open Source
-Philosophy `here <http://en.wikipedia.org/wiki/Open_source>`__. You can
+Philosophy `here <https://en.wikipedia.org/wiki/Open_source>`__. You can
 also find helpful information on how to participate in the Linux
 Community
 `here <https://www.kernel.org/doc/html/latest/process/index.html>`__.
@@ -291,7 +291,7 @@ While each development environment is unique, there are some best
 practices or methods that help development run smoothly. The following
 list describes some of these practices. For more information about Git
 workflows, see the workflow topics in the `Git Community
-Book <http://book.git-scm.com>`__.
+Book <https://book.git-scm.com>`__.
 
 -  *Make Small Changes:* It is best to keep the changes you commit small
    as compared to bundling many disparate changes into a single commit.
@@ -368,12 +368,12 @@ commands.
 .. note::
 
    -  For more information on Git, see
-      http://git-scm.com/documentation.
+      https://git-scm.com/documentation.
 
    -  If you need to download Git, it is recommended that you add Git to
       your system through your distribution's "software store" (e.g. for
       Ubuntu, use the Ubuntu Software feature). For the Git download
-      page, see http://git-scm.com/download.
+      page, see https://git-scm.com/download.
 
    -  For information beyond the introductory nature in this section,
       see the ":ref:`dev-manual/start:locating yocto project source files`"
@@ -507,7 +507,7 @@ you can manage with a small set of basic operations and workflows once
 you understand the basic philosophy behind Git. You do not have to be an
 expert in Git to be functional. A good place to look for instruction on
 a minimal set of Git commands is
-`here <http://git-scm.com/documentation>`__.
+`here <https://git-scm.com/documentation>`__.
 
 The following list of Git commands briefly describes some basic Git
 operations as a way to get started. As with any set of commands, this
@@ -614,10 +614,10 @@ and Free Software has an interesting history. If you are interested in
 this history, you can find basic information here:
 
 -  `Open source license
-   history <http://en.wikipedia.org/wiki/Open-source_license>`__
+   history <https://en.wikipedia.org/wiki/Open-source_license>`__
 
 -  `Free software license
-   history <http://en.wikipedia.org/wiki/Free_software_license>`__
+   history <https://en.wikipedia.org/wiki/Free_software_license>`__
 
 In general, the Yocto Project is broadly licensed under the
 Massachusetts Institute of Technology (MIT) License. MIT licensing
@@ -626,9 +626,9 @@ license is distributed with that software. MIT is also compatible with
 the GNU General Public License (GPL). Patches to the Yocto Project
 follow the upstream licensing scheme. You can find information on the
 MIT license
-`here <http://www.opensource.org/licenses/mit-license.php>`__. You can
+`here <https://www.opensource.org/licenses/mit-license.php>`__. You can
 find information on the GNU GPL
-`here <http://www.opensource.org/licenses/LGPL-3.0>`__.
+`here <https://www.opensource.org/licenses/LGPL-3.0>`__.
 
 When you build an image using the Yocto Project, the build process uses
 a known list of licenses to ensure compliance. You can find this list in
@@ -646,11 +646,11 @@ the developer to resolve potential licensing issues.
 
 The base list of licenses used by the build process is a combination of
 the Software Package Data Exchange (SPDX) list and the Open Source
-Initiative (OSI) projects. `SPDX Group <http://spdx.org>`__ is a working
+Initiative (OSI) projects. `SPDX Group <https://spdx.org>`__ is a working
 group of the Linux Foundation that maintains a specification for a
 standard format for communicating the components, licenses, and
 copyrights associated with a software package.
-`OSI <http://opensource.org>`__ is a corporation dedicated to the Open
+`OSI <https://opensource.org>`__ is a corporation dedicated to the Open
 Source Definition and the effort for reviewing and approving licenses
 that conform to the Open Source Definition (OSD).
 
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 980bfe5c2..91451fc04 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -368,7 +368,7 @@ activities using the Yocto Project:
 
 -  *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__
    is a fork of a project originally started by
-   `OzLabs <http://ozlabs.org/>`__. The project is a web-based tracking
+   `OzLabs <https://ozlabs.org/>`__. The project is a web-based tracking
    system designed to streamline the process of bringing contributions
    into a project. The Yocto Project uses Patchwork as an organizational
    tool to handle patches, which number in the thousands for every
@@ -400,7 +400,7 @@ activities using the Yocto Project:
 
    Historically, cross-prelink is a variant of prelink, which was
    conceived by `Jakub
-   Jelínek <http://people.redhat.com/jakub/prelink.pdf>`__ a number of
+   Jelínek <https://people.redhat.com/jakub/prelink.pdf>`__ a number of
    years ago. Both prelink and cross-prelink are maintained in the same
    repository albeit on separate branches. By providing an emulated
    runtime dynamic linker (i.e. ``glibc``-derived ``ld.so`` emulation),
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index 0da408443..b401cf904 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -39,7 +39,7 @@ other tools when it seems useful to do so.
 The coverage below details some of the most common ways you'll likely
 want to apply the tool; full documentation can be found either within
 the tool itself or in the man pages at
-`perf(1) <http://linux.die.net/man/1/perf>`__.
+`perf(1) <https://linux.die.net/man/1/perf>`__.
 
 Perf Setup
 ----------
@@ -860,7 +860,7 @@ the right kind of trace data, higher-level profiling-type summaries can
 be derived from it.
 
 Documentation on using the `'perf script' python
-binding <http://linux.die.net/man/1/perf-script-python>`__.
+binding <https://linux.die.net/man/1/perf-script-python>`__.
 
 System-Wide Tracing and Profiling
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1136,23 +1136,23 @@ Perf Documentation
 Online versions of the man pages for the commands discussed in this
 section can be found here:
 
--  The `'perf stat' manpage <http://linux.die.net/man/1/perf-stat>`__.
+-  The `'perf stat' manpage <https://linux.die.net/man/1/perf-stat>`__.
 
 -  The `'perf record'
-   manpage <http://linux.die.net/man/1/perf-record>`__.
+   manpage <https://linux.die.net/man/1/perf-record>`__.
 
 -  The `'perf report'
-   manpage <http://linux.die.net/man/1/perf-report>`__.
+   manpage <https://linux.die.net/man/1/perf-report>`__.
 
--  The `'perf probe' manpage <http://linux.die.net/man/1/perf-probe>`__.
+-  The `'perf probe' manpage <https://linux.die.net/man/1/perf-probe>`__.
 
 -  The `'perf script'
-   manpage <http://linux.die.net/man/1/perf-script>`__.
+   manpage <https://linux.die.net/man/1/perf-script>`__.
 
 -  Documentation on using the `'perf script' python
-   binding <http://linux.die.net/man/1/perf-script-python>`__.
+   binding <https://linux.die.net/man/1/perf-script-python>`__.
 
--  The top-level `perf(1) manpage <http://linux.die.net/man/1/perf>`__.
+-  The top-level `perf(1) manpage <https://linux.die.net/man/1/perf>`__.
 
 Normally, you should be able to invoke the man pages via perf itself
 e.g. 'perf help' or 'perf help record'.
@@ -1718,7 +1718,7 @@ events':
 
 The tool is pretty self-explanatory, but for more detailed information
 on navigating through the data, see the `kernelshark
-website <http://rostedt.homelinux.com/kernelshark/>`__.
+website <https://rostedt.homelinux.com/kernelshark/>`__.
 
 ftrace Documentation
 --------------------
@@ -1736,19 +1736,19 @@ Documentation directory: ::
 There is a nice series of articles on using ftrace and trace-cmd at LWN:
 
 -  `Debugging the kernel using Ftrace - part
-   1 <http://lwn.net/Articles/365835/>`__
+   1 <https://lwn.net/Articles/365835/>`__
 
 -  `Debugging the kernel using Ftrace - part
-   2 <http://lwn.net/Articles/366796/>`__
+   2 <https://lwn.net/Articles/366796/>`__
 
 -  `Secrets of the Ftrace function
-   tracer <http://lwn.net/Articles/370423/>`__
+   tracer <https://lwn.net/Articles/370423/>`__
 
 -  `trace-cmd: A front-end for
    Ftrace <https://lwn.net/Articles/410200/>`__
 
 There's more detailed documentation kernelshark usage here:
-`KernelShark <http://rostedt.homelinux.com/kernelshark/>`__
+`KernelShark <https://rostedt.homelinux.com/kernelshark/>`__
 
 An amusing yet useful README (a tracing mini-HOWTO) can be found in
 ``/sys/kernel/debug/tracing/README``.
@@ -1763,7 +1763,7 @@ gather/print/aggregate data extracted from the context they end up being
 invoked under.
 
 For example, this probe from the `SystemTap
-tutorial <http://sourceware.org/systemtap/tutorial/>`__ simply prints a
+tutorial <https://sourceware.org/systemtap/tutorial/>`__ simply prints a
 line every time any process on the system open()s a file. For each line,
 it prints the executable name of the program that opened the file, along
 with its PID, and the name of the file it opened (or tried to open),
@@ -1936,11 +1936,11 @@ systemtap Documentation
 -----------------------
 
 The SystemTap language reference can be found here: `SystemTap Language
-Reference <http://sourceware.org/systemtap/langref/>`__
+Reference <https://sourceware.org/systemtap/langref/>`__
 
 Links to other SystemTap documents, tutorials, and examples can be found
 here: `SystemTap documentation
-page <http://sourceware.org/systemtap/documentation.html>`__
+page <https://sourceware.org/systemtap/documentation.html>`__
 
 Sysprof
 =======
@@ -2214,7 +2214,7 @@ developers who are working in a Linux environment and are interested in
 efficient software tracing.
 
 For information on LTTng in general, visit the `LTTng
-Project <http://lttng.org/lttng2.0>`__ site. You can find a "Getting
+Project <https://lttng.org/lttng2.0>`__ site. You can find a "Getting
 Started" link on this site that takes you to an LTTng Quick Start.
 
 blktrace
@@ -2365,7 +2365,7 @@ first part of the filenames: ::
 The report shows each event that was
 found in the blktrace data, along with a summary of the overall block
 I/O traffic during the run. You can look at the
-`blkparse <http://linux.die.net/man/1/blkparse>`__ manpage to learn the
+`blkparse <https://linux.die.net/man/1/blkparse>`__ manpage to learn the
 meaning of each field displayed in the trace listing.
 
 Live Mode
@@ -2564,11 +2564,11 @@ blktrace Documentation
 Online versions of the man pages for the commands discussed in this
 section can be found here:
 
--  http://linux.die.net/man/8/blktrace
+-  https://linux.die.net/man/8/blktrace
 
--  http://linux.die.net/man/1/blkparse
+-  https://linux.die.net/man/1/blkparse
 
--  http://linux.die.net/man/8/btrace
+-  https://linux.die.net/man/8/btrace
 
 The above manpages, along with manpages for the other blktrace utilities
 (btt, blkiomon, etc) can be found in the /doc directory of the blktrace
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 5a30ce379..eb8b62702 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -278,7 +278,7 @@ The ``ccache`` class enables the C/C++ Compiler Cache for the build.
 This class is used to give a minor performance boost during the build.
 However, using the class can lead to unexpected side-effects. Thus, it
 is recommended that you do not use this class. See
-http://ccache.samba.org/ for information on the C/C++ Compiler
+https://ccache.samba.org/ for information on the C/C++ Compiler
 Cache.
 
 .. _ref-classes-chrpath:
@@ -2581,7 +2581,7 @@ the :term:`SYSTEMD_BOOT_CFG`,
 :term:`SYSTEMD_BOOT_TIMEOUT` variables.
 
 You can also see the `Systemd-boot
-documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__
+documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__
 for more information.
 
 .. _ref-classes-terminal:
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index f67c53824..34b26ee3e 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -55,9 +55,9 @@ Yocto Project is fairly straightforward.
 **Q:** Are there any products built using the OpenEmbedded build system?
 
 **A:** The software running on the `Vernier
-LabQuest <http://vernier.com/labquest/>`__ is built using the
+LabQuest <https://vernier.com/labquest/>`__ is built using the
 OpenEmbedded build system. See the `Vernier
-LabQuest <http://www.vernier.com/products/interfaces/labq/>`__ website
+LabQuest <https://www.vernier.com/products/interfaces/labq/>`__ website
 for more information. There are a number of pre-production devices using
 the OpenEmbedded build system and the Yocto Project team announces them
 as soon as they are released.
@@ -273,7 +273,7 @@ OpenEmbedded build system to use its internally built toolchain (i.e.
 particular, "external-\*" refers to external toolchains. One example is
 the Sourcery G++ Toolchain. The support for this toolchain resides in
 the separate ``meta-sourcery`` layer at
-http://github.com/MentorEmbedded/meta-sourcery/.
+https://github.com/MentorEmbedded/meta-sourcery/.
 
 In addition to the toolchain configuration, you also need a
 corresponding toolchain recipe file. This recipe file needs to package
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index 5e9374eae..cf5cc1109 100644
--- a/documentation/ref-manual/images.rst
+++ b/documentation/ref-manual/images.rst
@@ -37,9 +37,9 @@ Following is a list of supported recipes:
    all the pieces required to run builds using the build system as well
    as the build system itself. You can boot and run the image using
    either the `VMware
-   Player <http://www.vmware.com/products/player/overview.html>`__ or
+   Player <https://www.vmware.com/products/player/overview.html>`__ or
    `VMware
-   Workstation <http://www.vmware.com/products/workstation/overview.html>`__.
+   Workstation <https://www.vmware.com/products/workstation/overview.html>`__.
    For more information on this image, see the :yocto_home:`Build
    Appliance </software-item/build-appliance>` page
    on the Yocto Project website.
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index bb9c0460f..472820f16 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -24,7 +24,7 @@ The information lists the commands, their syntax, and meanings.
 Kickstart commands are based on the Fedora kickstart versions but with
 modifications to reflect Wic capabilities. You can see the original
 documentation for those commands at the following link:
-http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html
+https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html
 
 Command: part or partition
 ==========================
@@ -164,7 +164,7 @@ the ``part`` and ``partition`` commands:
 -  ``--part-type``: This option is a Wic-specific option that
    specifies the partition type globally unique identifier (GUID) for
    GPT partitions. You can find the list of partition type GUIDs at
-   http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs.
+   https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs.
 
 -  ``--use-uuid``: This option is a Wic-specific option that causes
    Wic to generate a random GUID for the partition. The generated
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst
index e8b3ada26..861d04861 100644
--- a/documentation/ref-manual/migration-2.1.rst
+++ b/documentation/ref-manual/migration-2.1.rst
@@ -89,7 +89,7 @@ package-specific nesting should be done by the package itself. Finally,
 having ``libexecdir`` change between recipes makes it very difficult for
 different recipes to invoke binaries that have been installed into
 ``libexecdir``. The Filesystem Hierarchy Standard (i.e.
-http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now
+https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now
 recognizes the use of ``${prefix}/libexec/``, giving distributions the
 choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without
 breaking FHS.
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
index 57ff011e7..23879d6b5 100644
--- a/documentation/ref-manual/migration-2.3.rst
+++ b/documentation/ref-manual/migration-2.3.rst
@@ -274,7 +274,7 @@ The following package management changes took place:
    fixed.
 
    For more information, see the `DNF
-   Documentation <http://dnf.readthedocs.io/en/latest/>`__.
+   Documentation <https://dnf.readthedocs.io/en/latest/>`__.
 
 -  Rpm 5.x is replaced with Rpm 4.x. This is done for two major reasons:
 
diff --git a/documentation/ref-manual/migration-2.7.rst b/documentation/ref-manual/migration-2.7.rst
index 7e628fc3e..5af5947ff 100644
--- a/documentation/ref-manual/migration-2.7.rst
+++ b/documentation/ref-manual/migration-2.7.rst
@@ -159,7 +159,7 @@ The following miscellaneous changes occurred:
    from the top-level ``scripts`` directory.
 
 -  Perl now builds for the target using
-   `perl-cross <http://arsv.github.io/perl-cross/>`_ for better
+   `perl-cross <https://arsv.github.io/perl-cross/>`_ for better
    maintainability and improved build performance. This change should
    not present any problems unless you have heavily customized your Perl
    recipe.
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 54977dcb2..6cb767d93 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -227,7 +227,7 @@ Errors and Warnings
       CFLAGS_append = " -fPIC "
 
    For more information on text relocations at runtime, see
-   http://www.akkadia.org/drepper/textrelocs.html.
+   https://www.akkadia.org/drepper/textrelocs.html.
 
     
 .. _qa-check-ldflags:
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 2c49c4e87..7554164d1 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -52,7 +52,7 @@ against the Yocto Project, see the following:
 
 -  The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
 
-For information on Bugzilla in general, see http://www.bugzilla.org/about/.
+For information on Bugzilla in general, see https://www.bugzilla.org/about/.
 
 .. _resources-mailinglist:
 
@@ -193,5 +193,5 @@ Here is a list of resources you might find helpful:
    available for Yocto Project and Poky discussions: ``#yocto`` and
    ``#poky``, respectively.
 
--  `Quick EMUlator (QEMU) <http://wiki.qemu.org/Index.html>`__\ *:* An
+-  `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__\ *:* An
    open-source machine emulator and virtualizer.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 8c6cc46b6..44e075ca4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2648,7 +2648,7 @@ system and gives an overview of their function and contents.
          GROUPADD_PARAM_${PN} = "-r netdev"
 
       For information on the standard Linux shell command
-      ``groupadd``, see http://linux.die.net/man/8/groupadd.
+      ``groupadd``, see https://linux.die.net/man/8/groupadd.
 
    :term:`GROUPMEMS_PARAM`
       When inheriting the :ref:`useradd <ref-classes-useradd>` class,
@@ -2657,7 +2657,7 @@ system and gives an overview of their function and contents.
       of a group when the package is installed.
 
       For information on the standard Linux shell command ``groupmems``,
-      see http://linux.die.net/man/8/groupmems.
+      see https://linux.die.net/man/8/groupmems.
 
    :term:`GRUB_GFXSERIAL`
       Configures the GNU GRand Unified Bootloader (GRUB) to have graphics
@@ -4679,7 +4679,7 @@ system and gives an overview of their function and contents.
       See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information.
 
    module_conf
-      Specifies `modprobe.d <http://linux.die.net/man/5/modprobe.d>`_
+      Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`_
       syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
       file.
 
@@ -7604,7 +7604,7 @@ system and gives an overview of their function and contents.
          SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf"
 
       For information on Systemd-boot, see the `Systemd-boot
-      documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
+      documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
 
    :term:`SYSTEMD_BOOT_ENTRIES`
       When :term:`EFI_PROVIDER` is set to
@@ -7618,7 +7618,7 @@ system and gives an overview of their function and contents.
           SYSTEMD_BOOT_ENTRIES ?= ""
 
       For information on Systemd-boot, see the `Systemd-boot
-      documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
+      documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
 
    :term:`SYSTEMD_BOOT_TIMEOUT`
       When :term:`EFI_PROVIDER` is set to
@@ -7631,7 +7631,7 @@ system and gives an overview of their function and contents.
          SYSTEMD_BOOT_TIMEOUT ?= "10"
 
       For information on Systemd-boot, see the `Systemd-boot
-      documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
+      documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
 
    :term:`SYSTEMD_PACKAGES`
       When inheriting the :ref:`systemd <ref-classes-systemd>` class,
@@ -7662,7 +7662,7 @@ system and gives an overview of their function and contents.
       When using
       :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`,
       specifies a space-separated list of the virtual terminals that should
-      run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__
+      run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__
       (allowing login), assuming :term:`USE_VT` is not set to
       "0".
 
@@ -7886,7 +7886,7 @@ system and gives an overview of their function and contents.
       toolchain. One example is the Sourcery G++ Toolchain. The support for
       this toolchain resides in the separate Mentor Graphics
       ``meta-sourcery`` layer at
-      http://github.com/MentorEmbedded/meta-sourcery/.
+      https://github.com/MentorEmbedded/meta-sourcery/.
 
       The layer's ``README`` file contains information on how to use the
       Sourcery G++ Toolchain as an external toolchain. In summary, you must
@@ -8562,7 +8562,7 @@ system and gives an overview of their function and contents.
       When using
       :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`,
       determines whether or not to run a
-      `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any
+      `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any
       virtual terminals in order to enable logging in through those
       terminals.
 
@@ -8673,7 +8673,7 @@ system and gives an overview of their function and contents.
 
       For information on the
       standard Linux shell command ``useradd``, see
-      http://linux.die.net/man/8/useradd.
+      https://linux.die.net/man/8/useradd.
 
    :term:`USERADD_UID_TABLES`
       Specifies a password file to use for obtaining static user
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
index 66b12cdff..e4b9b05ba 100644
--- a/documentation/sdk-manual/intro.rst
+++ b/documentation/sdk-manual/intro.rst
@@ -210,7 +210,7 @@ You just need to follow these general steps:
 3. *Develop and Test your Application:* At this point, you have the
    tools to develop your application. If you need to separately install
    and use the QEMU emulator, you can go to `QEMU Home
-   Page <http://wiki.qemu.org/Main_Page>`__ to download and learn about
+   Page <https://wiki.qemu.org/Main_Page>`__ to download and learn about
    the emulator. See the ":doc:`/dev-manual/qemu`" chapter in the
    Yocto Project Development Tasks Manual for information on using QEMU
    within the Yocto Project.
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index 34a1f39cf..d2ab14c8e 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -29,7 +29,7 @@ layer index's web application at :yocto_git:`/layerindex-web/`.
 
 When you tie a layer source into Toaster, it can query the layer source
 through a
-`REST <http://en.wikipedia.org/wiki/Representational_state_transfer>`__
+`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__
 API, store the information about the layers in the Toaster database, and
 then show the information to users. Users are then able to view that
 information and build layers from Toaster itself without worrying about
@@ -370,7 +370,7 @@ Remote Toaster Monitoring
 Toaster has an API that allows remote management applications to
 directly query the state of the Toaster server and its builds in a
 machine-to-machine manner. This API uses the
-`REST <http://en.wikipedia.org/wiki/Representational_state_transfer>`__
+`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__
 interface and the transfer of JSON files. For example, you might monitor
 a build inside a container through well supported known HTTP ports in
 order to easily access a Toaster server inside the container. In this
-- 
2.26.2


^ permalink raw reply related	[flat|nested] 10+ messages in thread

* Re: [docs] [PATCH v2 2/6] documentation: Simplify layerindex and layer links
  2020-12-22  9:57 ` [PATCH v2 2/6] documentation: Simplify layerindex and layer links Paul Barker
@ 2020-12-22 14:19   ` Quentin Schulz
  2020-12-22 14:45     ` Nicolas Dechesne
  2020-12-22 15:18     ` Paul Barker
  0 siblings, 2 replies; 10+ messages in thread
From: Quentin Schulz @ 2020-12-22 14:19 UTC (permalink / raw)
  To: Paul Barker; +Cc: docs

Hi Paul,

On Tue, Dec 22, 2020 at 09:57:54AM +0000, Paul Barker wrote:
> Signed-off-by: Paul Barker <pbarker@konsulko.com>
> ---
>  documentation/conf.py                             |  2 ++
>  documentation/dev-manual/common-tasks.rst         |  9 ++++-----
>  documentation/overview-manual/concepts.rst        | 15 ++++++---------
>  documentation/overview-manual/yp-intro.rst        |  6 ++----
>  documentation/ref-manual/migration-2.3.rst        |  2 +-
>  documentation/toaster-manual/intro.rst            |  2 +-
>  documentation/toaster-manual/reference.rst        |  4 ++--
>  documentation/toaster-manual/setup-and-use.rst    | 11 +++++------
>  .../transitioning-to-a-custom-environment.rst     |  4 ++--
>  documentation/what-i-wish-id-known.rst            | 11 +++++------
>  10 files changed, 30 insertions(+), 36 deletions(-)
> 
> diff --git a/documentation/conf.py b/documentation/conf.py
> index b5351599d..68eb92b0a 100644
> --- a/documentation/conf.py
> +++ b/documentation/conf.py
> @@ -80,6 +80,8 @@ extlinks = {
>      'oe_lists': ('https://lists.openembedded.org%s', None),
>      'oe_git': ('https://git.openembedded.org%s', None),
>      'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
> +    'oe_layerindex': ('https://layers.openembedded.org%s', None),
> +    'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),

I've contacted Michael Halstead about the issue we were talking about in
the v1. He's managed to redirect
https://layers.openembedded.org/layerindex/branch/master/layer/meta-xxx
to
https://layers.openembedded.org/layerindex/branch/master/layer/meta-xxx/

therefore we can have consistency in our docs and have only the leading
slash.

Please change your:
:oe_layer:`/meta-xxx/` into :oe_layer:`/meta-xxx`

>  }
>  
>  # Intersphinx config to use cross reference with Bitbake user manual
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index 39db6563c..b2f433e1d 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -38,9 +38,8 @@ Follow these general steps to create your layer without using tools:
>  
>  1. *Check Existing Layers:* Before creating a new layer, you should be
>     sure someone has not already created a layer containing the Metadata
> -   you need. You can see the `OpenEmbedded Metadata
> -   Index <https://layers.openembedded.org/layerindex/layers/>`__ for a
> -   list of layers from the OpenEmbedded community that can be used in
> +   you need. You can see the :oe_layer:`OpenEmbedded Metadata Index <>`

I'm pretty sure it's me who suggested this so my bad, this does not work
unfortunately :/

:oe_layer:`<>` results in https://layers.openembedded.org/layerindex/branch/master/layer/
but it's actually:
https://layers.openembedded.org/layerindex/branch/master/layers/ we want
(note the additional `s`).

What about:
'oe_metadataindex': ('https://layers.openembedded.org%s', None),
'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),

and have in poky.yaml:
OE_LAYERINDEX : "https://layers.openembedded.org/layerindex/layers/"
?

replacing :oe_layer:`<>` with &OE_LAYERINDEX; and :oe_layerindex:
with :oe_metadataindex: (if it is appropriate).

or 
'oe_metadataindex': ('https://layers.openembedded.org/layerindex%s', None),
'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),

replacing :oe_layer:`<>` with :oe_metadataindex:`/layers` (note at the
time of writing, this isn't working yet but I've asked Michael about it
already).

TL;DR: if we want to merge this ASAP, we'd probably want the
:oe_layer:`/meta-xxx/` into :oe_layer:`/meta-xxx` and
:oe_layer:`<>` into :oe_layerindex:`/layerindex/branch/master/layers` changes
and we can make the latter change neater in a followup patch.

> +   for a list of layers from the OpenEmbedded community that can be used in
>     the Yocto Project. You could find a layer that is identical or close
>     to what you need.
>  
> @@ -1194,8 +1193,8 @@ Before writing a recipe from scratch, it is often useful to discover
>  whether someone else has already written one that meets (or comes close
>  to meeting) your needs. The Yocto Project and OpenEmbedded communities
>  maintain many recipes that might be candidates for what you are doing.
> -You can find a good central index of these recipes in the `OpenEmbedded
> -Layer Index <https://layers.openembedded.org>`__.
> +You can find a good central index of these recipes in the
> +:oe_layerindex:`OpenEmbedded Layer Index <>`.
>  
>  Working from an existing recipe or a skeleton recipe is the best way to
>  get started. Here are some points on both methods:
> diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
> index 8fbbabbac..98c7b4f6b 100644
> --- a/documentation/overview-manual/concepts.rst
> +++ b/documentation/overview-manual/concepts.rst
> @@ -144,8 +144,7 @@ several pieces of hardware.
>  Many layers exist that work in the Yocto Project development
>  environment. The `Yocto Project Curated Layer
>  Index <https://www.yoctoproject.org/software-overview/layers/>`__
> -and `OpenEmbedded Layer
> -Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__
> +and :oe_layer:`OpenEmbedded Layer Index <>`
>  both contain layers from which you can use or leverage.
>  
>  By convention, layers in the Yocto Project follow a specific form.
> @@ -380,13 +379,11 @@ figure <#general-workflow-figure>`__:
>  
>  -  *Metadata (.bb + Patches):* Software layers containing
>     user-supplied recipe files, patches, and append files. A good example
> -   of a software layer might be the
> -   `meta-qt5 layer <https://github.com/meta-qt5/meta-qt5>`__ from
> -   the `OpenEmbedded Layer
> -   Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
> -   This layer is for version 5.0 of the popular
> -   `Qt <https://wiki.qt.io/About_Qt>`__ cross-platform application
> -   development framework for desktop, embedded and mobile.
> +   of a software layer might be the :oe_layer:`meta-qt5 layer </meta-qt5/>`
> +   from the :oe_layerindex:`OpenEmbedded Layer Index <>`. This layer is for

The outcome of :oe_layerindex:`OpenEmbedded Layer Index <>` is different
from http://layers.openembedded.org/layerindex/branch/master/layers/.

You probably wanted :oe_layer: here (though, it does not work, sadly).

> +   version 5.0 of the popular `Qt <https://wiki.qt.io/About_Qt>`__
> +   cross-platform application development framework for desktop, embedded and
> +   mobile.
>  
>  -  *Machine BSP Configuration:* Board Support Package (BSP) layers (i.e.
>     "BSP Layer" in the following figure) providing machine-specific
> diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
> index 456bfc549..980bfe5c2 100644
> --- a/documentation/overview-manual/yp-intro.rst
> +++ b/documentation/overview-manual/yp-intro.rst
> @@ -221,8 +221,7 @@ your Metadata, the easier it is to cope with future changes.
>  
>     -  Familiarize yourself with the `Yocto Project curated layer
>        index <https://www.yoctoproject.org/software-overview/layers/>`__
> -      or the `OpenEmbedded layer
> -      index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
> +      or the :oe_layer:`OpenEmbedded layer index <>`.
>        The latter contains more layers but they are less universally
>        validated.
>  
> @@ -364,8 +363,7 @@ activities using the Yocto Project:
>     versions available for Yocto Project. The main purpose of the system
>     is to help you manage the recipes you maintain and to offer a dynamic
>     overview of the project. The Recipe Reporting System is built on top
> -   of the `OpenEmbedded Layer
> -   Index <http://layers.openembedded.org/layerindex/layers/>`__, which
> +   of the :oe_layerindex:`OpenEmbedded Layer Index <>`, which

Ditto.

>     is a website that indexes OpenEmbedded-Core layers.
>  
>  -  *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__
> diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
> index 3e9758119..57ff011e7 100644
> --- a/documentation/ref-manual/migration-2.3.rst
> +++ b/documentation/ref-manual/migration-2.3.rst
> @@ -238,7 +238,7 @@ to substitute a GPLv2 version of a GPLv3 recipe, then you must add the
>  .. note::
>  
>     You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at
> -   https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/.
> +   :oe_layer:`/meta-gplv2/`.
>  
>  These relocated GPLv2 recipes do not receive the same level of
>  maintenance as other core recipes. The recipes do not get security fixes
> diff --git a/documentation/toaster-manual/intro.rst b/documentation/toaster-manual/intro.rst
> index c78b3f53d..57e5b2bb7 100644
> --- a/documentation/toaster-manual/intro.rst
> +++ b/documentation/toaster-manual/intro.rst
> @@ -27,7 +27,7 @@ extensive information about the build process.
>     -  Browse layers listed in the various
>        :ref:`layer sources <toaster-manual/reference:layer source>`
>        that are available in your project (e.g. the OpenEmbedded Layer Index at
> -      http://layers.openembedded.org/layerindex/).
> +      :oe_layerindex:`/`).

Probably wanted :oe_layer:`/` here since we're aiming at giving the link
to the Layer tab (though, yes, by default it redirects to the layer tab, and
yes, it does not work currently :)).

>  
>     -  Browse images, recipes, and machines provided by those layers.
>  
> diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
> index dfe51889e..34a1f39cf 100644
> --- a/documentation/toaster-manual/reference.rst
> +++ b/documentation/toaster-manual/reference.rst
> @@ -24,7 +24,7 @@ type of layer source called a "layer index."
>  A layer index is a web application that contains information about a set
>  of custom layers. A good example of an existing layer index is the
>  OpenEmbedded Layer Index. A public instance of this layer index exists
> -at http://layers.openembedded.org. You can find the code for this
> +at :oe_layerindex:`/`. You can find the code for this

Ditto.

>  layer index's web application at :yocto_git:`/layerindex-web/`.
>  
>  When you tie a layer source into Toaster, it can query the layer source
> @@ -81,7 +81,7 @@ describes two methods by which you can configure and use your layer
>  index.
>  
>  In the previous section, the code for the OpenEmbedded Metadata Index
> -(i.e. http://layers.openembedded.org) was referenced. You can use
> +(i.e. :oe_layerindex:`/`) was referenced. You can use
>  this code, which is at :yocto_git:`/layerindex-web/`, as a base to create
>  your own layer index.
>  
> diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst
> index 2cb7884eb..a3225da91 100644
> --- a/documentation/toaster-manual/setup-and-use.rst
> +++ b/documentation/toaster-manual/setup-and-use.rst
> @@ -462,9 +462,8 @@ Using the Toaster Web Interface
>  
>  The Toaster web interface allows you to do the following:
>  
> --  Browse published layers in the `OpenEmbedded Layer
> -   Index <http://layers.openembedded.org>`__ that are available for your
> -   selected version of the build system.
> +-  Browse published layers in the :oe_layer:`OpenEmbedded Layer Index <>`

Ditto.

> +   that are available for your selected version of the build system.
>  
>  -  Import your own layers for building.
>  
> @@ -573,11 +572,11 @@ However, the "Local Yocto Project" release will not provide you with any
>  compatible layers, other than the three core layers that come with the
>  Yocto Project:
>  
> --  `openembedded-core <http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/>`__
> +-  :oe_layer:`openembedded-core </openembedded-core/>`
>  
> --  `meta-poky <http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/>`__
> +-  :oe_layer:`meta-poky </meta-poky/>`
>  
> --  `meta-yocto-bsp <http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/>`__
> +-  :oe_layer:`meta-yocto-bsp </meta-yocto-bsp/>`
>  
>  .. image:: figures/compatible-layers.png
>     :align: center
> diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst
> index 415f295b3..76a3215de 100644
> --- a/documentation/transitioning-to-a-custom-environment.rst
> +++ b/documentation/transitioning-to-a-custom-environment.rst
> @@ -29,8 +29,8 @@ Transitioning to a custom environment for systems development
>  
>  #. **Find and acquire the best BSP for your target**.
>     Use the :yocto_home:`Yocto Project curated layer index
> -   </software-overview/layers/>` or even the `OpenEmbedded layer index
> -   <https://layers.openembedded.org>`_ to find and acquire the best BSP for your
> +   </software-overview/layers/>` or even the :oe_layer:`OpenEmbedded
> +   layer index <>` to find and acquire the best BSP for your

Ditto.

>     target board. The Yocto Project layer index BSPs are regularly validated. The
>     best place to get your first BSP is from your silicon manufacturer or board
>     vendor – they can point you to their most qualified efforts. In general, for
> diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
> index a051036bb..a52a16656 100644
> --- a/documentation/what-i-wish-id-known.rst
> +++ b/documentation/what-i-wish-id-known.rst
> @@ -27,11 +27,10 @@ contact us with other suggestions.
>     to be responsible for your own updates.
>  
>  #. **Get to know the layer index:**
> -   All layers can be found in the `layer index
> -   <https://layers.openembedded.org/>`_. Layers which have applied for Yocto
> -   Project Compatible status (structure continuity assurance and testing) can be
> -   found in the :yocto_home:`Yocto Project Compatible index
> -   </software-over/layer/>`.  Generally check the Compatible layer index first,
> +   All layers can be found in the :oe_layer:`layer index <>`. Layers which
> +   have applied for Yocto Project Compatible status (structure continuity
> +   assurance and testing) can be found in the :yocto_home:`Yocto Project Compatible index
> +   </software-over/layer/>`. Generally check the Compatible layer index first,
>     and if you don't find the necessary layer check the general layer index. The
>     layer index is an original artifact from the Open Embedded Project. As such,
>     that index doesn't have the curating and testing that the Yocto Project
> @@ -172,7 +171,7 @@ contact us with other suggestions.
>     * add an ssh server to an image (enable transferring of files to target)
>     * know the anatomy of a recipe
>     * know how to create and use layers
> -   * find recipes (with the `OpenEmbedded Layer index <https://layers.openembedded.org>`_)
> +   * find recipes (with the :oe_layerindex:`OpenEmbedded Layer index <>`)

If we went for the second suggested :oe_metadataindex:, we could use:
:oe_metadataindex:`/recipes` here.

Thanks,
Quentin

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [docs] [PATCH v2 2/6] documentation: Simplify layerindex and layer links
  2020-12-22 14:19   ` [docs] " Quentin Schulz
@ 2020-12-22 14:45     ` Nicolas Dechesne
  2020-12-22 15:18     ` Paul Barker
  1 sibling, 0 replies; 10+ messages in thread
From: Nicolas Dechesne @ 2020-12-22 14:45 UTC (permalink / raw)
  To: Quentin Schulz; +Cc: Paul Barker, YP docs mailing list

On Tue, Dec 22, 2020 at 3:19 PM Quentin Schulz
<quentin.schulz@streamunlimited.com> wrote:
>
> Hi Paul,
>
> On Tue, Dec 22, 2020 at 09:57:54AM +0000, Paul Barker wrote:
> > Signed-off-by: Paul Barker <pbarker@konsulko.com>
> > ---
> >  documentation/conf.py                             |  2 ++
> >  documentation/dev-manual/common-tasks.rst         |  9 ++++-----
> >  documentation/overview-manual/concepts.rst        | 15 ++++++---------
> >  documentation/overview-manual/yp-intro.rst        |  6 ++----
> >  documentation/ref-manual/migration-2.3.rst        |  2 +-
> >  documentation/toaster-manual/intro.rst            |  2 +-
> >  documentation/toaster-manual/reference.rst        |  4 ++--
> >  documentation/toaster-manual/setup-and-use.rst    | 11 +++++------
> >  .../transitioning-to-a-custom-environment.rst     |  4 ++--
> >  documentation/what-i-wish-id-known.rst            | 11 +++++------
> >  10 files changed, 30 insertions(+), 36 deletions(-)
> >
> > diff --git a/documentation/conf.py b/documentation/conf.py
> > index b5351599d..68eb92b0a 100644
> > --- a/documentation/conf.py
> > +++ b/documentation/conf.py
> > @@ -80,6 +80,8 @@ extlinks = {
> >      'oe_lists': ('https://lists.openembedded.org%s', None),
> >      'oe_git': ('https://git.openembedded.org%s', None),
> >      'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
> > +    'oe_layerindex': ('https://layers.openembedded.org%s', None),
> > +    'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
>
> I've contacted Michael Halstead about the issue we were talking about in
> the v1. He's managed to redirect
> https://layers.openembedded.org/layerindex/branch/master/layer/meta-xxx
> to
> https://layers.openembedded.org/layerindex/branch/master/layer/meta-xxx/
>
> therefore we can have consistency in our docs and have only the leading
> slash.

that's pretty cool. Thanks Quentin and Michael for this change!

>
> Please change your:
> :oe_layer:`/meta-xxx/` into :oe_layer:`/meta-xxx`
>
> >  }
> >
> >  # Intersphinx config to use cross reference with Bitbake user manual
> > diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> > index 39db6563c..b2f433e1d 100644
> > --- a/documentation/dev-manual/common-tasks.rst
> > +++ b/documentation/dev-manual/common-tasks.rst
> > @@ -38,9 +38,8 @@ Follow these general steps to create your layer without using tools:
> >
> >  1. *Check Existing Layers:* Before creating a new layer, you should be
> >     sure someone has not already created a layer containing the Metadata
> > -   you need. You can see the `OpenEmbedded Metadata
> > -   Index <https://layers.openembedded.org/layerindex/layers/>`__ for a
> > -   list of layers from the OpenEmbedded community that can be used in
> > +   you need. You can see the :oe_layer:`OpenEmbedded Metadata Index <>`
>
> I'm pretty sure it's me who suggested this so my bad, this does not work
> unfortunately :/
>
> :oe_layer:`<>` results in https://layers.openembedded.org/layerindex/branch/master/layer/
> but it's actually:
> https://layers.openembedded.org/layerindex/branch/master/layers/ we want
> (note the additional `s`).
>
> What about:
> 'oe_metadataindex': ('https://layers.openembedded.org%s', None),
> 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
>
> and have in poky.yaml:
> OE_LAYERINDEX : "https://layers.openembedded.org/layerindex/layers/"
> ?

I am not sure I like this idea, it duplicates the link in conf.py and
poky.yaml for not much benefit.

>
> replacing :oe_layer:`<>` with &OE_LAYERINDEX; and :oe_layerindex:
> with :oe_metadataindex: (if it is appropriate).
>
> or
> 'oe_metadataindex': ('https://layers.openembedded.org/layerindex%s', None),
> 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
>
> replacing :oe_layer:`<>` with :oe_metadataindex:`/layers` (note at the
> time of writing, this isn't working yet but I've asked Michael about it
> already).
>
> TL;DR: if we want to merge this ASAP, we'd probably want the
> :oe_layer:`/meta-xxx/` into :oe_layer:`/meta-xxx` and
> :oe_layer:`<>` into :oe_layerindex:`/layerindex/branch/master/layers` changes
> and we can make the latter change neater in a followup patch.

I agree. let's do that for now. I think we haven't still figured out
the best way to use extlinks for the layer index links.. but we should
unblock these patches, and deal with that separately.

It would be interesting to explore (in a different patch series) using this:
'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/%s',
None),

so that any of the following should work:
:oe_layer:`layers`
:oe_layer:`layer/meta-foo`
:oe_layer:`recipes`
:oe_layer:`recipe/xxx`


>
> > +   for a list of layers from the OpenEmbedded community that can be used in
> >     the Yocto Project. You could find a layer that is identical or close
> >     to what you need.
> >
> > @@ -1194,8 +1193,8 @@ Before writing a recipe from scratch, it is often useful to discover
> >  whether someone else has already written one that meets (or comes close
> >  to meeting) your needs. The Yocto Project and OpenEmbedded communities
> >  maintain many recipes that might be candidates for what you are doing.
> > -You can find a good central index of these recipes in the `OpenEmbedded
> > -Layer Index <https://layers.openembedded.org>`__.
> > +You can find a good central index of these recipes in the
> > +:oe_layerindex:`OpenEmbedded Layer Index <>`.
> >
> >  Working from an existing recipe or a skeleton recipe is the best way to
> >  get started. Here are some points on both methods:
> > diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
> > index 8fbbabbac..98c7b4f6b 100644
> > --- a/documentation/overview-manual/concepts.rst
> > +++ b/documentation/overview-manual/concepts.rst
> > @@ -144,8 +144,7 @@ several pieces of hardware.
> >  Many layers exist that work in the Yocto Project development
> >  environment. The `Yocto Project Curated Layer
> >  Index <https://www.yoctoproject.org/software-overview/layers/>`__
> > -and `OpenEmbedded Layer
> > -Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__
> > +and :oe_layer:`OpenEmbedded Layer Index <>`
> >  both contain layers from which you can use or leverage.
> >
> >  By convention, layers in the Yocto Project follow a specific form.
> > @@ -380,13 +379,11 @@ figure <#general-workflow-figure>`__:
> >
> >  -  *Metadata (.bb + Patches):* Software layers containing
> >     user-supplied recipe files, patches, and append files. A good example
> > -   of a software layer might be the
> > -   `meta-qt5 layer <https://github.com/meta-qt5/meta-qt5>`__ from
> > -   the `OpenEmbedded Layer
> > -   Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
> > -   This layer is for version 5.0 of the popular
> > -   `Qt <https://wiki.qt.io/About_Qt>`__ cross-platform application
> > -   development framework for desktop, embedded and mobile.
> > +   of a software layer might be the :oe_layer:`meta-qt5 layer </meta-qt5/>`
> > +   from the :oe_layerindex:`OpenEmbedded Layer Index <>`. This layer is for
>
> The outcome of :oe_layerindex:`OpenEmbedded Layer Index <>` is different
> from http://layers.openembedded.org/layerindex/branch/master/layers/.
>
> You probably wanted :oe_layer: here (though, it does not work, sadly).
>
> > +   version 5.0 of the popular `Qt <https://wiki.qt.io/About_Qt>`__
> > +   cross-platform application development framework for desktop, embedded and
> > +   mobile.
> >
> >  -  *Machine BSP Configuration:* Board Support Package (BSP) layers (i.e.
> >     "BSP Layer" in the following figure) providing machine-specific
> > diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
> > index 456bfc549..980bfe5c2 100644
> > --- a/documentation/overview-manual/yp-intro.rst
> > +++ b/documentation/overview-manual/yp-intro.rst
> > @@ -221,8 +221,7 @@ your Metadata, the easier it is to cope with future changes.
> >
> >     -  Familiarize yourself with the `Yocto Project curated layer
> >        index <https://www.yoctoproject.org/software-overview/layers/>`__
> > -      or the `OpenEmbedded layer
> > -      index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
> > +      or the :oe_layer:`OpenEmbedded layer index <>`.
> >        The latter contains more layers but they are less universally
> >        validated.
> >
> > @@ -364,8 +363,7 @@ activities using the Yocto Project:
> >     versions available for Yocto Project. The main purpose of the system
> >     is to help you manage the recipes you maintain and to offer a dynamic
> >     overview of the project. The Recipe Reporting System is built on top
> > -   of the `OpenEmbedded Layer
> > -   Index <http://layers.openembedded.org/layerindex/layers/>`__, which
> > +   of the :oe_layerindex:`OpenEmbedded Layer Index <>`, which
>
> Ditto.
>
> >     is a website that indexes OpenEmbedded-Core layers.
> >
> >  -  *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__
> > diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
> > index 3e9758119..57ff011e7 100644
> > --- a/documentation/ref-manual/migration-2.3.rst
> > +++ b/documentation/ref-manual/migration-2.3.rst
> > @@ -238,7 +238,7 @@ to substitute a GPLv2 version of a GPLv3 recipe, then you must add the
> >  .. note::
> >
> >     You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at
> > -   https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/.
> > +   :oe_layer:`/meta-gplv2/`.
> >
> >  These relocated GPLv2 recipes do not receive the same level of
> >  maintenance as other core recipes. The recipes do not get security fixes
> > diff --git a/documentation/toaster-manual/intro.rst b/documentation/toaster-manual/intro.rst
> > index c78b3f53d..57e5b2bb7 100644
> > --- a/documentation/toaster-manual/intro.rst
> > +++ b/documentation/toaster-manual/intro.rst
> > @@ -27,7 +27,7 @@ extensive information about the build process.
> >     -  Browse layers listed in the various
> >        :ref:`layer sources <toaster-manual/reference:layer source>`
> >        that are available in your project (e.g. the OpenEmbedded Layer Index at
> > -      http://layers.openembedded.org/layerindex/).
> > +      :oe_layerindex:`/`).
>
> Probably wanted :oe_layer:`/` here since we're aiming at giving the link
> to the Layer tab (though, yes, by default it redirects to the layer tab, and
> yes, it does not work currently :)).
>
> >
> >     -  Browse images, recipes, and machines provided by those layers.
> >
> > diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
> > index dfe51889e..34a1f39cf 100644
> > --- a/documentation/toaster-manual/reference.rst
> > +++ b/documentation/toaster-manual/reference.rst
> > @@ -24,7 +24,7 @@ type of layer source called a "layer index."
> >  A layer index is a web application that contains information about a set
> >  of custom layers. A good example of an existing layer index is the
> >  OpenEmbedded Layer Index. A public instance of this layer index exists
> > -at http://layers.openembedded.org. You can find the code for this
> > +at :oe_layerindex:`/`. You can find the code for this
>
> Ditto.
>
> >  layer index's web application at :yocto_git:`/layerindex-web/`.
> >
> >  When you tie a layer source into Toaster, it can query the layer source
> > @@ -81,7 +81,7 @@ describes two methods by which you can configure and use your layer
> >  index.
> >
> >  In the previous section, the code for the OpenEmbedded Metadata Index
> > -(i.e. http://layers.openembedded.org) was referenced. You can use
> > +(i.e. :oe_layerindex:`/`) was referenced. You can use
> >  this code, which is at :yocto_git:`/layerindex-web/`, as a base to create
> >  your own layer index.
> >
> > diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst
> > index 2cb7884eb..a3225da91 100644
> > --- a/documentation/toaster-manual/setup-and-use.rst
> > +++ b/documentation/toaster-manual/setup-and-use.rst
> > @@ -462,9 +462,8 @@ Using the Toaster Web Interface
> >
> >  The Toaster web interface allows you to do the following:
> >
> > --  Browse published layers in the `OpenEmbedded Layer
> > -   Index <http://layers.openembedded.org>`__ that are available for your
> > -   selected version of the build system.
> > +-  Browse published layers in the :oe_layer:`OpenEmbedded Layer Index <>`
>
> Ditto.
>
> > +   that are available for your selected version of the build system.
> >
> >  -  Import your own layers for building.
> >
> > @@ -573,11 +572,11 @@ However, the "Local Yocto Project" release will not provide you with any
> >  compatible layers, other than the three core layers that come with the
> >  Yocto Project:
> >
> > --  `openembedded-core <http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/>`__
> > +-  :oe_layer:`openembedded-core </openembedded-core/>`
> >
> > --  `meta-poky <http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/>`__
> > +-  :oe_layer:`meta-poky </meta-poky/>`
> >
> > --  `meta-yocto-bsp <http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/>`__
> > +-  :oe_layer:`meta-yocto-bsp </meta-yocto-bsp/>`
> >
> >  .. image:: figures/compatible-layers.png
> >     :align: center
> > diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst
> > index 415f295b3..76a3215de 100644
> > --- a/documentation/transitioning-to-a-custom-environment.rst
> > +++ b/documentation/transitioning-to-a-custom-environment.rst
> > @@ -29,8 +29,8 @@ Transitioning to a custom environment for systems development
> >
> >  #. **Find and acquire the best BSP for your target**.
> >     Use the :yocto_home:`Yocto Project curated layer index
> > -   </software-overview/layers/>` or even the `OpenEmbedded layer index
> > -   <https://layers.openembedded.org>`_ to find and acquire the best BSP for your
> > +   </software-overview/layers/>` or even the :oe_layer:`OpenEmbedded
> > +   layer index <>` to find and acquire the best BSP for your
>
> Ditto.
>
> >     target board. The Yocto Project layer index BSPs are regularly validated. The
> >     best place to get your first BSP is from your silicon manufacturer or board
> >     vendor – they can point you to their most qualified efforts. In general, for
> > diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
> > index a051036bb..a52a16656 100644
> > --- a/documentation/what-i-wish-id-known.rst
> > +++ b/documentation/what-i-wish-id-known.rst
> > @@ -27,11 +27,10 @@ contact us with other suggestions.
> >     to be responsible for your own updates.
> >
> >  #. **Get to know the layer index:**
> > -   All layers can be found in the `layer index
> > -   <https://layers.openembedded.org/>`_. Layers which have applied for Yocto
> > -   Project Compatible status (structure continuity assurance and testing) can be
> > -   found in the :yocto_home:`Yocto Project Compatible index
> > -   </software-over/layer/>`.  Generally check the Compatible layer index first,
> > +   All layers can be found in the :oe_layer:`layer index <>`. Layers which
> > +   have applied for Yocto Project Compatible status (structure continuity
> > +   assurance and testing) can be found in the :yocto_home:`Yocto Project Compatible index
> > +   </software-over/layer/>`. Generally check the Compatible layer index first,
> >     and if you don't find the necessary layer check the general layer index. The
> >     layer index is an original artifact from the Open Embedded Project. As such,
> >     that index doesn't have the curating and testing that the Yocto Project
> > @@ -172,7 +171,7 @@ contact us with other suggestions.
> >     * add an ssh server to an image (enable transferring of files to target)
> >     * know the anatomy of a recipe
> >     * know how to create and use layers
> > -   * find recipes (with the `OpenEmbedded Layer index <https://layers.openembedded.org>`_)
> > +   * find recipes (with the :oe_layerindex:`OpenEmbedded Layer index <>`)
>
> If we went for the second suggested :oe_metadataindex:, we could use:
> :oe_metadataindex:`/recipes` here.
>
> Thanks,
> Quentin
>
> 
>

^ permalink raw reply	[flat|nested] 10+ messages in thread

* Re: [docs] [PATCH v2 2/6] documentation: Simplify layerindex and layer links
  2020-12-22 14:19   ` [docs] " Quentin Schulz
  2020-12-22 14:45     ` Nicolas Dechesne
@ 2020-12-22 15:18     ` Paul Barker
  1 sibling, 0 replies; 10+ messages in thread
From: Paul Barker @ 2020-12-22 15:18 UTC (permalink / raw)
  To: Quentin Schulz; +Cc: YP docs mailing list

On Tue, 22 Dec 2020 at 14:19, Quentin Schulz
<quentin.schulz@streamunlimited.com> wrote:
>
> Hi Paul,
>
> On Tue, Dec 22, 2020 at 09:57:54AM +0000, Paul Barker wrote:
> > Signed-off-by: Paul Barker <pbarker@konsulko.com>
> > ---
> >  documentation/conf.py                             |  2 ++
> >  documentation/dev-manual/common-tasks.rst         |  9 ++++-----
> >  documentation/overview-manual/concepts.rst        | 15 ++++++---------
> >  documentation/overview-manual/yp-intro.rst        |  6 ++----
> >  documentation/ref-manual/migration-2.3.rst        |  2 +-
> >  documentation/toaster-manual/intro.rst            |  2 +-
> >  documentation/toaster-manual/reference.rst        |  4 ++--
> >  documentation/toaster-manual/setup-and-use.rst    | 11 +++++------
> >  .../transitioning-to-a-custom-environment.rst     |  4 ++--
> >  documentation/what-i-wish-id-known.rst            | 11 +++++------
> >  10 files changed, 30 insertions(+), 36 deletions(-)
> >
> > diff --git a/documentation/conf.py b/documentation/conf.py
> > index b5351599d..68eb92b0a 100644
> > --- a/documentation/conf.py
> > +++ b/documentation/conf.py
> > @@ -80,6 +80,8 @@ extlinks = {
> >      'oe_lists': ('https://lists.openembedded.org%s', None),
> >      'oe_git': ('https://git.openembedded.org%s', None),
> >      'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
> > +    'oe_layerindex': ('https://layers.openembedded.org%s', None),
> > +    'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
>
> I've contacted Michael Halstead about the issue we were talking about in
> the v1. He's managed to redirect
> https://layers.openembedded.org/layerindex/branch/master/layer/meta-xxx
> to
> https://layers.openembedded.org/layerindex/branch/master/layer/meta-xxx/
>
> therefore we can have consistency in our docs and have only the leading
> slash.
>
> Please change your:
> :oe_layer:`/meta-xxx/` into :oe_layer:`/meta-xxx`

Will do, thanks for following this up.

>
> >  }
> >
> >  # Intersphinx config to use cross reference with Bitbake user manual
> > diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> > index 39db6563c..b2f433e1d 100644
> > --- a/documentation/dev-manual/common-tasks.rst
> > +++ b/documentation/dev-manual/common-tasks.rst
> > @@ -38,9 +38,8 @@ Follow these general steps to create your layer without using tools:
> >
> >  1. *Check Existing Layers:* Before creating a new layer, you should be
> >     sure someone has not already created a layer containing the Metadata
> > -   you need. You can see the `OpenEmbedded Metadata
> > -   Index <https://layers.openembedded.org/layerindex/layers/>`__ for a
> > -   list of layers from the OpenEmbedded community that can be used in
> > +   you need. You can see the :oe_layer:`OpenEmbedded Metadata Index <>`
>
> I'm pretty sure it's me who suggested this so my bad, this does not work
> unfortunately :/
>
> :oe_layer:`<>` results in https://layers.openembedded.org/layerindex/branch/master/layer/
> but it's actually:
> https://layers.openembedded.org/layerindex/branch/master/layers/ we want
> (note the additional `s`).
>
> What about:
> 'oe_metadataindex': ('https://layers.openembedded.org%s', None),
> 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
>
> and have in poky.yaml:
> OE_LAYERINDEX : "https://layers.openembedded.org/layerindex/layers/"
> ?
>
> replacing :oe_layer:`<>` with &OE_LAYERINDEX; and :oe_layerindex:
> with :oe_metadataindex: (if it is appropriate).
>
> or
> 'oe_metadataindex': ('https://layers.openembedded.org/layerindex%s', None),
> 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
>
> replacing :oe_layer:`<>` with :oe_metadataindex:`/layers` (note at the
> time of writing, this isn't working yet but I've asked Michael about it
> already).
>
> TL;DR: if we want to merge this ASAP, we'd probably want the
> :oe_layer:`/meta-xxx/` into :oe_layer:`/meta-xxx` and
> :oe_layer:`<>` into :oe_layerindex:`/layerindex/branch/master/layers` changes
> and we can make the latter change neater in a followup patch.

TBH I'm just going to fall back to what I had originally here. We'll use:

    :oe_layerindex:`OpenEmbedded Metadata Index <>`

If someone changes the default tab so the layer index in the future
then the docs can be changed at that time.

-- 
Paul Barker
Konsulko Group

^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2020-12-22 15:19 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-22  9:57 [PATCH v2 0/6] Tidy up links in documentation Paul Barker
2020-12-22  9:57 ` [PATCH v2 1/6] documentation: Simplify oe_wiki and oe_home links Paul Barker
2020-12-22  9:57 ` [PATCH v2 2/6] documentation: Simplify layerindex and layer links Paul Barker
2020-12-22 14:19   ` [docs] " Quentin Schulz
2020-12-22 14:45     ` Nicolas Dechesne
2020-12-22 15:18     ` Paul Barker
2020-12-22  9:57 ` [PATCH v2 3/6] documentation: Simplify remaining yocto_home links Paul Barker
2020-12-22  9:57 ` [PATCH v2 4/6] profile-manual: Simplify yocto_bugs link Paul Barker
2020-12-22  9:57 ` [PATCH v2 5/6] ref-manual: Simplify oe_lists link Paul Barker
2020-12-22  9:57 ` [PATCH v2 6/6] documentation: Use https links where possible Paul Barker

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.