Simplify links using yocto_wiki, yocto_git and oe_git directives
cover Simplify links using yocto_wiki, yocto_git and oe_git directives
These changes simplify use of the yocto_wiki and yocto_git directives. All links in the text which can use these directives are tidied up.
Note that these patches are based on top of Nicolas' recent series to remove labels [1] to simplify applying them together (assuming that series is ok). The combined patches can be pulled from:
https://gitlab.com/pbarker.dev/staging/yocto-docs.git
tag: labels-and-links_2020-11-27
[1]: https://lists.yoctoproject.org/g/docs/topic/patch_0_7_a_second_pass_at/78526569
Paul Barker (3):
documentation: Simplify yocto_wiki links
documentation: Simplify yocto_git links
ref-manual: Simplify oe_git links
.../brief-yoctoprojectqs.rst | 2 +- documentation/bsp-guide/bsp.rst | 23 ++++---- documentation/conf.py | 4 +- .../dev-manual/dev-manual-common-tasks.rst | 53 +++++++++---------- documentation/dev-manual/dev-manual-start.rst | 6 +-- .../kernel-dev/kernel-dev-advanced.rst | 4 +- .../kernel-dev/kernel-dev-common.rst | 4 +- .../kernel-dev/kernel-dev-maint-appx.rst | 4 +- .../overview-manual-concepts.rst | 17 +++--- ...verview-manual-development-environment.rst | 7 ++- .../overview-manual-yp-intro.rst | 12 ++--- documentation/ref-manual/faq.rst | 4 +- documentation/ref-manual/migration-1.3.rst | 2 +- documentation/ref-manual/migration-1.5.rst | 2 +- documentation/ref-manual/migration-1.6.rst | 2 +- documentation/ref-manual/migration-1.7.rst | 4 +- documentation/ref-manual/migration-1.8.rst | 2 +- documentation/ref-manual/migration-2.2.rst | 4 +- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/migration-2.5.rst | 6 +-- documentation/ref-manual/migration-3.0.rst | 2 +- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/ref-classes.rst | 2 +- .../ref-manual/ref-devtool-reference.rst | 4 +- .../ref-manual/ref-release-process.rst | 4 +- .../ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-tasks.rst | 2 +- documentation/ref-manual/ref-terms.rst | 4 +- documentation/ref-manual/ref-variables.rst | 6 +-- documentation/ref-manual/resources.rst | 9 ++-- .../test-manual/test-manual-intro.rst | 6 +-- .../test-manual/test-manual-test-process.rst | 8 +-- .../test-manual-understand-autobuilder.rst | 2 +- .../toaster-manual-reference.rst | 15 +++--- .../toaster-manual-setup-and-use.rst | 4 +- 35 files changed, 113 insertions(+), 123 deletions(-)
Signature · 1 line
2.26.2
PATCH 1/3 documentation: Simplify yocto_wiki links
The yocto_wiki external link directive is modified to include the /wiki element of the URL so that we can simplify the links in the text.
Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in index.rst.
--- .../brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +- documentation/bsp-guide/bsp.rst | 2 +- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 14 +++++++------- documentation/dev-manual/dev-manual-start.rst | 2 +- documentation/kernel-dev/kernel-dev-common.rst | 4 ++-- documentation/ref-manual/faq.rst | 4 ++-- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 4 ++-- .../ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/ref-manual/resources.rst | 9 +++++---- documentation/test-manual/test-manual-intro.rst | 2 +- .../test-manual/test-manual-test-process.rst | 2 +- .../test-manual-understand-autobuilder.rst | 2 +- 15 files changed, 29 insertions(+), 28 deletions(-)
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +1 -1
@@ -165,7 +165,7 @@ an entire Linux distribution, including the toolchain, from source. infrastructure resources and get that information. A good starting point could also be to check your web browser settings. Finally, you can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" page of the Yocto Project Wiki. #. **Initialize the Build Environment:** From within the ``poky``
documentation/bsp-guide/bsp.rst +1 -1
@@ -854,7 +854,7 @@ Before looking at BSP requirements, you should consider the following: a BSP. You should consult the packaging and distribution guidelines for your specific release process. For an example of packaging and distribution requirements, see the ":yocto_wiki:`Third Party BSP Release - Process </wiki/Third_Party_BSP_Release_Process>`" + Process </Third_Party_BSP_Release_Process>`" wiki page. - The requirements for the BSP as it is made available to a developer
documentation/conf.py +1 -1
@@ -69,7 +69,7 @@ rst_prolog = """ # external links and substitutions extlinks = { 'yocto_home': ('https://yoctoproject.org%s', None), - 'yocto_wiki': ('https://wiki.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), 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),
documentation/dev-manual/dev-manual-common-tasks.rst +7 -7
@@ -135,7 +135,7 @@ Follow these general steps to create your layer without using tools: Lists all layers on which this layer depends (if any). - :term:`LAYERSERIES_COMPAT`: - Lists the :yocto_wiki:`Yocto Project </wiki/Releases>` + Lists the :yocto_wiki:`Yocto Project </Releases>` releases for which the current version is compatible. This variable is a good way to indicate if your particular layer is current.
@@ -6476,7 +6476,7 @@ the following: build system uses this string to help define the value of ``PV`` when the source code revision needs to be included in it. -- :yocto_wiki:`PR Service </wiki/PR_Service>`: A +- :yocto_wiki:`PR Service </PR_Service>`: A network-based service that helps automate keeping package feeds compatible with existing package manager applications such as RPM, APT, and OPKG.
@@ -6518,7 +6518,7 @@ revision field, which removes the human element. .. note:: For additional information on using a PR Service, you can see the - :yocto_wiki:`PR Service </wiki/PR_Service>` wiki page. + :yocto_wiki:`PR Service </PR_Service>` wiki page. The Yocto Project uses variables in order of decreasing priority to facilitate revision numbering (i.e.
@@ -7314,7 +7314,7 @@ where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and the testname can be any identifying string. For a list of Yocto Project recipes that are already enabled with ptest, -see the :yocto_wiki:`Ptest </wiki/Ptest>` wiki page. +see the :yocto_wiki:`Ptest </Ptest>` wiki page. .. note::
@@ -10320,7 +10320,7 @@ Here are some other tips that you might find useful: Project implementation of :yocto_bugs:`Bugzilla <>`. For information on how to submit a bug against the Yocto Project, see the Yocto Project - Bugzilla :yocto_wiki:`wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` + Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` and the "`Submitting a Defect Against the Yocto Project <#submitting-a-defect-against-the-yocto-project>`__" section.
@@ -10348,7 +10348,7 @@ implementation of Bugzilla see the ":ref:`Yocto Project Bugzilla <resources-bugtracker>`" section in the Yocto Project Reference Manual. For more detail on any of the following steps, see the Yocto Project -:yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`. +:yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`. Use the following general steps to submit a bug:
@@ -10812,7 +10812,7 @@ master branch or the fix on the master branch is unsuitable for backporting. The list of stable branches along with the status and maintainer for each branch can be obtained from the -:yocto_wiki:`Releases wiki page </wiki/Releases>`. +:yocto_wiki:`Releases wiki page </Releases>`. .. note::
documentation/dev-manual/dev-manual-start.rst +1 -1
@@ -305,7 +305,7 @@ Project Build Host: validation and their status, see the ":ref:`Supported Linux Distributions <detailed-supported-distros>`" section in the Yocto Project Reference Manual and the wiki page at - :yocto_wiki:`Distribution Support </wiki/Distribution_Support>`. + :yocto_wiki:`Distribution Support </Distribution_Support>`. 2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes of free disk space for building images.
documentation/kernel-dev/kernel-dev-common.rst +2 -2
@@ -207,7 +207,7 @@ section: building for actual hardware and not for emulation, you could flash the image to a USB stick on ``/dev/sdd`` and boot your device. For an example that uses a Minnowboard, see the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki page. At this point you have set up to start making modifications to the
@@ -862,7 +862,7 @@ the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devto If the image you originally created resulted in a Wic file, you can use an alternate method to create the new image with the updated kernel. For an example, see the steps in the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki Page. ::
documentation/ref-manual/faq.rst +2 -2
@@ -140,7 +140,7 @@ The Yocto Project also includes a ``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS and Git proxy servers if needed. For more information on setting up various proxy types and configuring proxy servers, see the -":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" +":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. **Q:** What's the difference between target and target\ ``-native``?
@@ -362,7 +362,7 @@ redirect requests through proxy servers. .. note:: You can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. **Q:** Can I get rid of build output so I can start over?
documentation/ref-manual/migration-3.2.rst +1 -1
@@ -71,7 +71,7 @@ be monitoring. In addition, pseudo's behaviour on mismatches has now been changed - rather than doing what turns out to be a rather dangerous "fixup" if it sees a file with a different path but the same inode as another file it has previously seen, -pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </wiki/Pseudo_Abort>` +pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` that explains how to deal with this.
documentation/ref-manual/ref-release-process.rst +2 -2
@@ -64,7 +64,7 @@ codename are likely to be compatible and thus work together. Releases are given a nominal release version as well but the codename is used in repositories for this reason. You can find information on Yocto Project releases and codenames at -:yocto_wiki:`/wiki/Releases`. +:yocto_wiki:`/Releases`. Stable Release Process ======================
@@ -94,7 +94,7 @@ Community LTS trees and branches exist where community members share patches for older releases. However, these types of patches do not go through the same release process as do point releases. You can find more information about stable branch maintenance at -:yocto_wiki:`/wiki/Stable_branch_maintenance`. +:yocto_wiki:`/Stable_branch_maintenance`. Testing and Quality Assurance =============================
documentation/ref-manual/ref-system-requirements.rst +1 -1
@@ -93,7 +93,7 @@ distributions: Bugzilla <>` and submit a bug. We are interested in hearing about your experience. For information on how to submit a bug, see the Yocto Project - :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` + :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual.
documentation/ref-manual/ref-variables.rst +2 -2
@@ -1997,7 +1997,7 @@ system and gives an overview of their function and contents. process gets source files when working behind a firewall or proxy server, see this specific question in the ":doc:`faq`" chapter. You can also refer to the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. :term:`DOC_COMPRESS`
@@ -4177,7 +4177,7 @@ system and gives an overview of their function and contents. To specify the OE-Core versions for which a layer is compatible, use this variable in your layer's ``conf/layer.conf`` configuration file. For the list, use the Yocto Project - :yocto_wiki:`Release Name </wiki/Releases>` (e.g. + :yocto_wiki:`Release Name </Releases>` (e.g. DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the layer, use a space-separated list: ::
documentation/ref-manual/resources.rst +5 -4
@@ -50,7 +50,7 @@ against the Yocto Project, see the following: - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual. -- The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` +- 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/.
@@ -108,7 +108,7 @@ Here is a list of resources you might find helpful: - :yocto_home:`The Yocto Project Website <>`\ *:* The home site for the Yocto Project. -- :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for +- :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for the Yocto Project. This page contains information about project planning, release engineering, QA & automation, a reference site map, and other resources related to the Yocto Project.
@@ -171,7 +171,7 @@ Here is a list of resources you might find helpful: the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. -- :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked +- :yocto_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked questions and their answers. - *Release Notes:* Features, updates and known issues for the current
@@ -184,7 +184,8 @@ Here is a list of resources you might find helpful: the Yocto Project uses. If you find problems with the Yocto Project, you should report them using this application. -- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:* +- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page + </Bugzilla_Configuration_and_Bug_Tracking>`\ *:* Information on how to get set up and use the Yocto Project implementation of Bugzilla for logging and tracking Yocto Project defects.
documentation/test-manual/test-manual-intro.rst +1 -1
@@ -144,7 +144,7 @@ thefollowing types of tests: :ref:`Testing Packages With ptest <dev-manual/dev-manual-common-tasks:Testing Packages With ptest>` section in the Yocto Project Development Tasks Manual and the - ":yocto_wiki:`Ptest </wiki/Ptest>`" Wiki page for more + ":yocto_wiki:`Ptest </Ptest>`" Wiki page for more information on Ptest. - *SDK Testing:* Image tests initiated through the following command::
documentation/test-manual/test-manual-test-process.rst +1 -1
@@ -25,7 +25,7 @@ at: :yocto_ab:`/typhoon/#/console`. Builds are triggered manually when the test branches are ready. The builds are monitored by the SWAT team. For additional information, see -:yocto_wiki:`/wiki/Yocto_Build_Failure_Swat_Team`. +:yocto_wiki:`/Yocto_Build_Failure_Swat_Team`. If successful, the changes would usually be merged to the ``master`` branch. If not successful, someone would respond to the changes on the mailing list explaining that there was a failure in testing. The choice
documentation/test-manual/test-manual-understand-autobuilder.rst +1 -1
@@ -195,7 +195,7 @@ Resulttool is part of OpenEmbedded-Core and is used to manipulate these json results files. It has the ability to merge files together, display reports of the test results and compare different result files. -For details, see :yocto_wiki:`/wiki/Resulttool`. +For details, see :yocto_wiki:`/Resulttool`. run-config Target Execution ===========================
Signature · 1 line
2.26.2
Re: [docs] [PATCH 1/3] documentation: Simplify yocto_wiki links
hi Paul,
Quoted 4 lines · Paul Barker
The
yocto_wikiexternal link directive is modified to include the/wikielement of the URL so that we can simplify the links in the text.
thanks for sending these patches!
Quoted 28 lines
Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in
index.rst.Signed-off-by Paul Barker <[email protected]>--- .../brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +- documentation/bsp-guide/bsp.rst | 2 +- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 14 +++++++------- documentation/dev-manual/dev-manual-start.rst | 2 +- documentation/kernel-dev/kernel-dev-common.rst | 4 ++-- documentation/ref-manual/faq.rst | 4 ++-- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 4 ++-- .../ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/ref-manual/resources.rst | 9 +++++---- documentation/test-manual/test-manual-intro.rst | 2 +- .../test-manual/test-manual-test-process.rst | 2 +- .../test-manual-understand-autobuilder.rst | 2 +- 15 files changed, 29 insertions(+), 28 deletions(-)documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +0
-0
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst an entire Linux distribution, including the toolchain, from source. · line 168
Quoted 5 lines
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +1
-1@@ -165,7 +165,7 @@ an entire Linux distribution, including the toolchain, from source. infrastructure resources and get that information. A good starting point could also be to check your web browser settings. Finally, you can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
Is it possible to get rid of the 'leading' /, so that the links become:
:yocto_wiki:My Awesome Page <My_Awesome_Page>
I remember looking into that initially, but I forgot what's possible..
Quoted 309 lines
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +0
-0page of the Yocto Project Wiki. #. **Initialize the Build Environment:** From within the ``poky``documentation/bsp-guide/bsp.rst +1
-1@@ -854,7 +854,7 @@ Before looking at BSP requirements, you should consider the following: a BSP. You should consult the packaging and distribution guidelines for your specific release process. For an example of packaging and distribution requirements, see the ":yocto_wiki:`Third Party BSP Release - Process </wiki/Third_Party_BSP_Release_Process>`" + Process </Third_Party_BSP_Release_Process>`" wiki page. - The requirements for the BSP as it is made available to a developerdocumentation/conf.py +1
-1@@ -69,7 +69,7 @@ rst_prolog = """ # external links and substitutions extlinks = { 'yocto_home': ('https://yoctoproject.org%s', None), - 'yocto_wiki': ('https://wiki.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), 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),documentation/dev-manual/dev-manual-common-tasks.rst +7
-7@@ -135,7 +135,7 @@ Follow these general steps to create your layer without using tools: Lists all layers on which this layer depends (if any). - :term:`LAYERSERIES_COMPAT`: - Lists the :yocto_wiki:`Yocto Project </wiki/Releases>` + Lists the :yocto_wiki:`Yocto Project </Releases>` releases for which the current version is compatible. This variable is a good way to indicate if your particular layer is current.@@ -6476,7 +6476,7 @@ the following: build system uses this string to help define the value of ``PV`` when the source code revision needs to be included in it. -- :yocto_wiki:`PR Service </wiki/PR_Service>`: A +- :yocto_wiki:`PR Service </PR_Service>`: A network-based service that helps automate keeping package feeds compatible with existing package manager applications such as RPM, APT, and OPKG.@@ -6518,7 +6518,7 @@ revision field, which removes the human element. .. note:: For additional information on using a PR Service, you can see the - :yocto_wiki:`PR Service </wiki/PR_Service>` wiki page. + :yocto_wiki:`PR Service </PR_Service>` wiki page. The Yocto Project uses variables in order of decreasing priority to facilitate revision numbering (i.e.@@ -7314,7 +7314,7 @@ where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and the testname can be any identifying string. For a list of Yocto Project recipes that are already enabled with ptest, -see the :yocto_wiki:`Ptest </wiki/Ptest>` wiki page. +see the :yocto_wiki:`Ptest </Ptest>` wiki page. .. note::@@ -10320,7 +10320,7 @@ Here are some other tips that you might find useful: Project implementation of :yocto_bugs:`Bugzilla <>`. For information on how to submit a bug against the Yocto Project, see the Yocto Project - Bugzilla :yocto_wiki:`wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` + Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` and the "`Submitting a Defect Against the Yocto Project <#submitting-a-defect-against-the-yocto-project>`__" section.@@ -10348,7 +10348,7 @@ implementation of Bugzilla see the ":ref:`Yocto Project Bugzilla <resources-bugtracker>`" section in the Yocto Project Reference Manual. For more detail on any of the following steps, see the Yocto Project -:yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`. +:yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`. Use the following general steps to submit a bug:@@ -10812,7 +10812,7 @@ master branch or the fix on the master branch is unsuitable for backporting. The list of stable branches along with the status and maintainer for each branch can be obtained from the -:yocto_wiki:`Releases wiki page </wiki/Releases>`. +:yocto_wiki:`Releases wiki page </Releases>`. .. note::documentation/dev-manual/dev-manual-start.rst +1
-1@@ -305,7 +305,7 @@ Project Build Host: validation and their status, see the ":ref:`Supported Linux Distributions <detailed-supported-distros>`" section in the Yocto Project Reference Manual and the wiki page at - :yocto_wiki:`Distribution Support </wiki/Distribution_Support>`. + :yocto_wiki:`Distribution Support </Distribution_Support>`. 2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes of free disk space for building images.documentation/kernel-dev/kernel-dev-common.rst +2
-2@@ -207,7 +207,7 @@ section: building for actual hardware and not for emulation, you could flash the image to a USB stick on ``/dev/sdd`` and boot your device. For an example that uses a Minnowboard, see the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki page. At this point you have set up to start making modifications to the@@ -862,7 +862,7 @@ the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devto If the image you originally created resulted in a Wic file, you can use an alternate method to create the new image with the updated kernel. For an example, see the steps in the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki Page. ::documentation/ref-manual/faq.rst +2
-2@@ -140,7 +140,7 @@ The Yocto Project also includes a ``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS and Git proxy servers if needed. For more information on setting up various proxy types and configuring proxy servers, see the -":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" +":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. **Q:** What's the difference between target and target\ ``-native``?@@ -362,7 +362,7 @@ redirect requests through proxy servers. .. note:: You can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. **Q:** Can I get rid of build output so I can start over?documentation/ref-manual/migration-3.2.rst +1
-1@@ -71,7 +71,7 @@ be monitoring. In addition, pseudo's behaviour on mismatches has now been changed - rather than doing what turns out to be a rather dangerous "fixup" if it sees a file with a different path but the same inode as another file it has previously seen, -pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </wiki/Pseudo_Abort>` +pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` that explains how to deal with this.documentation/ref-manual/ref-release-process.rst +2
-2@@ -64,7 +64,7 @@ codename are likely to be compatible and thus work together. Releases are given a nominal release version as well but the codename is used in repositories for this reason. You can find information on Yocto Project releases and codenames at -:yocto_wiki:`/wiki/Releases`. +:yocto_wiki:`/Releases`. Stable Release Process ======================@@ -94,7 +94,7 @@ Community LTS trees and branches exist where community members share patches for older releases. However, these types of patches do not go through the same release process as do point releases. You can find more information about stable branch maintenance at -:yocto_wiki:`/wiki/Stable_branch_maintenance`. +:yocto_wiki:`/Stable_branch_maintenance`. Testing and Quality Assurance =============================documentation/ref-manual/ref-system-requirements.rst +1
-1@@ -93,7 +93,7 @@ distributions: Bugzilla <>` and submit a bug. We are interested in hearing about your experience. For information on how to submit a bug, see the Yocto Project - :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` + :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual.documentation/ref-manual/ref-variables.rst +2
-2@@ -1997,7 +1997,7 @@ system and gives an overview of their function and contents. process gets source files when working behind a firewall or proxy server, see this specific question in the ":doc:`faq`" chapter. You can also refer to the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. :term:`DOC_COMPRESS`@@ -4177,7 +4177,7 @@ system and gives an overview of their function and contents. To specify the OE-Core versions for which a layer is compatible, use this variable in your layer's ``conf/layer.conf`` configuration file. For the list, use the Yocto Project - :yocto_wiki:`Release Name </wiki/Releases>` (e.g. + :yocto_wiki:`Release Name </Releases>` (e.g. DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the layer, use a space-separated list: ::documentation/ref-manual/resources.rst +5
-4@@ -50,7 +50,7 @@ against the Yocto Project, see the following: - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual. -- The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` +- 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/.@@ -108,7 +108,7 @@ Here is a list of resources you might find helpful: - :yocto_home:`The Yocto Project Website <>`\ *:* The home site for the Yocto Project. -- :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for +- :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for the Yocto Project. This page contains information about project planning, release engineering, QA & automation, a reference site map, and other resources related to the Yocto Project.@@ -171,7 +171,7 @@ Here is a list of resources you might find helpful: the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. -- :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked +- :yocto_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked questions and their answers. - *Release Notes:* Features, updates and known issues for the current@@ -184,7 +184,8 @@ Here is a list of resources you might find helpful: the Yocto Project uses. If you find problems with the Yocto Project, you should report them using this application. -- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:* +- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page + </Bugzilla_Configuration_and_Bug_Tracking>`\ *:* Information on how to get set up and use the Yocto Project implementation of Bugzilla for logging and tracking Yocto Project defects.documentation/test-manual/test-manual-intro.rst +1
-1@@ -144,7 +144,7 @@ thefollowing types of tests: :ref:`Testing Packages With ptest <dev-manual/dev-manual-common-tasks:Testing Packages With ptest>` section in the Yocto Project Development Tasks Manual and the - ":yocto_wiki:`Ptest </wiki/Ptest>`" Wiki page for more + ":yocto_wiki:`Ptest </Ptest>`" Wiki page for more information on Ptest. - *SDK Testing:* Image tests initiated through the following command::documentation/test-manual/test-manual-test-process.rst +1
-1@@ -25,7 +25,7 @@ at: :yocto_ab:`/typhoon/#/console`. Builds are triggered manually when the test branches are ready. The builds are monitored by the SWAT team. For additional information, see -:yocto_wiki:`/wiki/Yocto_Build_Failure_Swat_Team`. +:yocto_wiki:`/Yocto_Build_Failure_Swat_Team`. If successful, the changes would usually be merged to the ``master`` branch. If not successful, someone would respond to the changes on the mailing list explaining that there was a failure in testing. The choicedocumentation/test-manual/test-manual-understand-autobuilder.rst +1
-2@@ -195,7 +195,7 @@ Resulttool is part of OpenEmbedded-Core and is used to manipulate these json results files. It has the ability to merge files together, display reports of the test results and compare different result files. -For details, see :yocto_wiki:`/wiki/Resulttool`. +For details, see :yocto_wiki:`/Resulttool`. run-config Target Execution =========================== --2.26.2
Re: [docs] [PATCH 1/3] documentation: Simplify yocto_wiki links
Quoted 48 lines · Nicolas Dechesne
hi Paul,
Quoted 4 lines · Paul Barker
The
yocto_wikiexternal link directive is modified to include the/wikielement of the URL so that we can simplify the links in the text.thanks for sending these patches!
Quoted 28 lines
Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in
index.rst.Signed-off-by Paul Barker <[email protected]>--- .../brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +- documentation/bsp-guide/bsp.rst | 2 +- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 14 +++++++------- documentation/dev-manual/dev-manual-start.rst | 2 +- documentation/kernel-dev/kernel-dev-common.rst | 4 ++-- documentation/ref-manual/faq.rst | 4 ++-- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 4 ++-- .../ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/ref-manual/resources.rst | 9 +++++---- documentation/test-manual/test-manual-intro.rst | 2 +- .../test-manual/test-manual-test-process.rst | 2 +- .../test-manual-understand-autobuilder.rst | 2 +- 15 files changed, 29 insertions(+), 28 deletions(-)documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +0
-0documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst an entire Linux distribution, including the toolchain, from source. · line 168
Quoted 5 lines
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +1
-1@@ -165,7 +165,7 @@ an entire Linux distribution, including the toolchain, from source. infrastructure resources and get that information. A good starting point could also be to check your web browser settings. Finally, you can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"Is it possible to get rid of the 'leading' /, so that the links become:
:yocto_wiki:My Awesome Page <My_Awesome_Page>
Quoted 1 line
I remember looking into that initially, but I forgot what's possible..
It's probably possible but I think it'd be confusing unless we make the change for every directive in extlinks in conf.py. Changing all the directives would be a huge amount of churn for what I think is limited benefit.
Signature · 2 lines
Paul Barker Konsulko Group
Re: [docs] [PATCH 1/3] documentation: Simplify yocto_wiki links
Quoted 51 lines · Paul Barker
Quoted 48 lines · Nicolas Dechesne
hi Paul,
Quoted 4 lines · Paul Barker
The
yocto_wikiexternal link directive is modified to include the/wikielement of the URL so that we can simplify the links in the text.thanks for sending these patches!
Quoted 28 lines
Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in
index.rst.Signed-off-by Paul Barker <[email protected]>--- .../brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +- documentation/bsp-guide/bsp.rst | 2 +- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 14 +++++++------- documentation/dev-manual/dev-manual-start.rst | 2 +- documentation/kernel-dev/kernel-dev-common.rst | 4 ++-- documentation/ref-manual/faq.rst | 4 ++-- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 4 ++-- .../ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/ref-manual/resources.rst | 9 +++++---- documentation/test-manual/test-manual-intro.rst | 2 +- .../test-manual/test-manual-test-process.rst | 2 +- .../test-manual-understand-autobuilder.rst | 2 +- 15 files changed, 29 insertions(+), 28 deletions(-)documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +0
-0documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst an entire Linux distribution, including the toolchain, from source. · line 168
Quoted 5 lines
documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +1
-1@@ -165,7 +165,7 @@ an entire Linux distribution, including the toolchain, from source. infrastructure resources and get that information. A good starting point could also be to check your web browser settings. Finally, you can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"Is it possible to get rid of the 'leading' /, so that the links become:
:yocto_wiki:My Awesome Page <My_Awesome_Page>
Quoted 6 lines
Quoted 1 line
I remember looking into that initially, but I forgot what's possible..
It's probably possible but I think it'd be confusing unless we make the change for every directive in extlinks in
conf.py. Changing all the directives would be a huge amount of churn for what I think is limited benefit.
Fair enough. Especially because I think it rings a bell.. and I believe I left them for a reason... but I don't remember now.. the extlinks role is a bit fragile to be honest.. if I had figured out the poky.yaml before extlinks, I think i would not have used extlinks..
Quoted 4 lines
--
Paul Barker
Konsulko Group
Re: [docs] [PATCH 1/3] documentation: Simplify yocto_wiki links
In reply to Paul BarkerQuoted 8 lines · Paul Barker
The
yocto_wikiexternal link directive is modified to include the/wikielement of the URL so that we can simplify the links in the text.Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in
index.rst.
Quoted 7 lines
Signed-off-by Paul Barker <[email protected]>--- .../brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +- documentation/bsp-guide/bsp.rst | 2 +- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 14 +++++++------- documentation/dev-manual/dev-manual-start.rst | 2 +-
You missed one instance in dev-manual-start.rst:
For a "map" of Yocto Project releases to version numbers, see
the
:yocto_wiki:Releases </wiki/Releases> wiki page.
I found it with make linkcheck
Quoted 331 lines
documentation/kernel-dev/kernel-dev-common.rst | 4 ++-- documentation/ref-manual/faq.rst | 4 ++-- documentation/ref-manual/migration-3.2.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 4 ++-- .../ref-manual/ref-system-requirements.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/ref-manual/resources.rst | 9 +++++---- documentation/test-manual/test-manual-intro.rst | 2 +- .../test-manual/test-manual-test-process.rst | 2 +- .../test-manual-understand-autobuilder.rst | 2 +- 15 files changed, 29 insertions(+), 28 deletions(-)documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +1
-1@@ -165,7 +165,7 @@ an entire Linux distribution, including the toolchain, from source. infrastructure resources and get that information. A good starting point could also be to check your web browser settings. Finally, you can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" page of the Yocto Project Wiki. #. **Initialize the Build Environment:** From within the ``poky``documentation/bsp-guide/bsp.rst +1
-1@@ -854,7 +854,7 @@ Before looking at BSP requirements, you should consider the following: a BSP. You should consult the packaging and distribution guidelines for your specific release process. For an example of packaging and distribution requirements, see the ":yocto_wiki:`Third Party BSP Release - Process </wiki/Third_Party_BSP_Release_Process>`" + Process </Third_Party_BSP_Release_Process>`" wiki page. - The requirements for the BSP as it is made available to a developerdocumentation/conf.py +1
-1@@ -69,7 +69,7 @@ rst_prolog = """ # external links and substitutions extlinks = { 'yocto_home': ('https://yoctoproject.org%s', None), - 'yocto_wiki': ('https://wiki.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), 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),documentation/dev-manual/dev-manual-common-tasks.rst +7
-7@@ -135,7 +135,7 @@ Follow these general steps to create your layer without using tools: Lists all layers on which this layer depends (if any). - :term:`LAYERSERIES_COMPAT`: - Lists the :yocto_wiki:`Yocto Project </wiki/Releases>` + Lists the :yocto_wiki:`Yocto Project </Releases>` releases for which the current version is compatible. This variable is a good way to indicate if your particular layer is current.@@ -6476,7 +6476,7 @@ the following: build system uses this string to help define the value of ``PV`` when the source code revision needs to be included in it. -- :yocto_wiki:`PR Service </wiki/PR_Service>`: A +- :yocto_wiki:`PR Service </PR_Service>`: A network-based service that helps automate keeping package feeds compatible with existing package manager applications such as RPM, APT, and OPKG.@@ -6518,7 +6518,7 @@ revision field, which removes the human element. .. note:: For additional information on using a PR Service, you can see the - :yocto_wiki:`PR Service </wiki/PR_Service>` wiki page. + :yocto_wiki:`PR Service </PR_Service>` wiki page. The Yocto Project uses variables in order of decreasing priority to facilitate revision numbering (i.e.@@ -7314,7 +7314,7 @@ where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and the testname can be any identifying string. For a list of Yocto Project recipes that are already enabled with ptest, -see the :yocto_wiki:`Ptest </wiki/Ptest>` wiki page. +see the :yocto_wiki:`Ptest </Ptest>` wiki page. .. note::@@ -10320,7 +10320,7 @@ Here are some other tips that you might find useful: Project implementation of :yocto_bugs:`Bugzilla <>`. For information on how to submit a bug against the Yocto Project, see the Yocto Project - Bugzilla :yocto_wiki:`wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` + Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` and the "`Submitting a Defect Against the Yocto Project <#submitting-a-defect-against-the-yocto-project>`__" section.@@ -10348,7 +10348,7 @@ implementation of Bugzilla see the ":ref:`Yocto Project Bugzilla <resources-bugtracker>`" section in the Yocto Project Reference Manual. For more detail on any of the following steps, see the Yocto Project -:yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`. +:yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`. Use the following general steps to submit a bug:@@ -10812,7 +10812,7 @@ master branch or the fix on the master branch is unsuitable for backporting. The list of stable branches along with the status and maintainer for each branch can be obtained from the -:yocto_wiki:`Releases wiki page </wiki/Releases>`. +:yocto_wiki:`Releases wiki page </Releases>`. .. note::documentation/dev-manual/dev-manual-start.rst +1
-1@@ -305,7 +305,7 @@ Project Build Host: validation and their status, see the ":ref:`Supported Linux Distributions <detailed-supported-distros>`" section in the Yocto Project Reference Manual and the wiki page at - :yocto_wiki:`Distribution Support </wiki/Distribution_Support>`. + :yocto_wiki:`Distribution Support </Distribution_Support>`. 2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes of free disk space for building images.documentation/kernel-dev/kernel-dev-common.rst +2
-2@@ -207,7 +207,7 @@ section: building for actual hardware and not for emulation, you could flash the image to a USB stick on ``/dev/sdd`` and boot your device. For an example that uses a Minnowboard, see the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki page. At this point you have set up to start making modifications to the@@ -862,7 +862,7 @@ the ":ref:`kernel-dev/kernel-dev-common:getting ready to develop using \`\`devto If the image you originally created resulted in a Wic file, you can use an alternate method to create the new image with the updated kernel. For an example, see the steps in the - :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </wiki/TipsAndTricks/KernelDevelopmentWithEsdk>` + :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` Wiki Page. ::documentation/ref-manual/faq.rst +2
-2@@ -140,7 +140,7 @@ The Yocto Project also includes a ``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS and Git proxy servers if needed. For more information on setting up various proxy types and configuring proxy servers, see the -":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" +":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. **Q:** What's the difference between target and target\ ``-native``?@@ -362,7 +362,7 @@ redirect requests through proxy servers. .. note:: You can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. **Q:** Can I get rid of build output so I can start over?documentation/ref-manual/migration-3.2.rst +1
-1@@ -71,7 +71,7 @@ be monitoring. In addition, pseudo's behaviour on mismatches has now been changed - rather than doing what turns out to be a rather dangerous "fixup" if it sees a file with a different path but the same inode as another file it has previously seen, -pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </wiki/Pseudo_Abort>` +pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` that explains how to deal with this.documentation/ref-manual/ref-release-process.rst +2
-2@@ -64,7 +64,7 @@ codename are likely to be compatible and thus work together. Releases are given a nominal release version as well but the codename is used in repositories for this reason. You can find information on Yocto Project releases and codenames at -:yocto_wiki:`/wiki/Releases`. +:yocto_wiki:`/Releases`. Stable Release Process ======================@@ -94,7 +94,7 @@ Community LTS trees and branches exist where community members share patches for older releases. However, these types of patches do not go through the same release process as do point releases. You can find more information about stable branch maintenance at -:yocto_wiki:`/wiki/Stable_branch_maintenance`. +:yocto_wiki:`/Stable_branch_maintenance`. Testing and Quality Assurance =============================documentation/ref-manual/ref-system-requirements.rst +1
-1@@ -93,7 +93,7 @@ distributions: Bugzilla <>` and submit a bug. We are interested in hearing about your experience. For information on how to submit a bug, see the Yocto Project - :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` + :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual.documentation/ref-manual/ref-variables.rst +2
-2@@ -1997,7 +1997,7 @@ system and gives an overview of their function and contents. process gets source files when working behind a firewall or proxy server, see this specific question in the ":doc:`faq`" chapter. You can also refer to the - ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" Wiki page. :term:`DOC_COMPRESS`@@ -4177,7 +4177,7 @@ system and gives an overview of their function and contents. To specify the OE-Core versions for which a layer is compatible, use this variable in your layer's ``conf/layer.conf`` configuration file. For the list, use the Yocto Project - :yocto_wiki:`Release Name </wiki/Releases>` (e.g. + :yocto_wiki:`Release Name </Releases>` (e.g. DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the layer, use a space-separated list: ::documentation/ref-manual/resources.rst +5
-4@@ -50,7 +50,7 @@ against the Yocto Project, see the following: - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" section in the Yocto Project Development Tasks Manual. -- The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` +- 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/.@@ -108,7 +108,7 @@ Here is a list of resources you might find helpful: - :yocto_home:`The Yocto Project Website <>`\ *:* The home site for the Yocto Project. -- :yocto_wiki:`The Yocto Project Main Wiki Page </wiki/Main_Page>`\ *:* The main wiki page for +- :yocto_wiki:`The Yocto Project Main Wiki Page <>`\ *:* The main wiki page for the Yocto Project. This page contains information about project planning, release engineering, QA & automation, a reference site map, and other resources related to the Yocto Project.@@ -171,7 +171,7 @@ Here is a list of resources you might find helpful: the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. -- :yocto_wiki:`FAQ </wiki/FAQ>`\ *:* A list of commonly asked +- :yocto_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked questions and their answers. - *Release Notes:* Features, updates and known issues for the current@@ -184,7 +184,8 @@ Here is a list of resources you might find helpful: the Yocto Project uses. If you find problems with the Yocto Project, you should report them using this application. -- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`\ *:* +- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page + </Bugzilla_Configuration_and_Bug_Tracking>`\ *:* Information on how to get set up and use the Yocto Project implementation of Bugzilla for logging and tracking Yocto Project defects.documentation/test-manual/test-manual-intro.rst +1
-1@@ -144,7 +144,7 @@ thefollowing types of tests: :ref:`Testing Packages With ptest <dev-manual/dev-manual-common-tasks:Testing Packages With ptest>` section in the Yocto Project Development Tasks Manual and the - ":yocto_wiki:`Ptest </wiki/Ptest>`" Wiki page for more + ":yocto_wiki:`Ptest </Ptest>`" Wiki page for more information on Ptest. - *SDK Testing:* Image tests initiated through the following command::documentation/test-manual/test-manual-test-process.rst +1
-1@@ -25,7 +25,7 @@ at: :yocto_ab:`/typhoon/#/console`. Builds are triggered manually when the test branches are ready. The builds are monitored by the SWAT team. For additional information, see -:yocto_wiki:`/wiki/Yocto_Build_Failure_Swat_Team`. +:yocto_wiki:`/Yocto_Build_Failure_Swat_Team`. If successful, the changes would usually be merged to the ``master`` branch. If not successful, someone would respond to the changes on the mailing list explaining that there was a failure in testing. The choicedocumentation/test-manual/test-manual-understand-autobuilder.rst +1
-2@@ -195,7 +195,7 @@ Resulttool is part of OpenEmbedded-Core and is used to manipulate these json results files. It has the ability to merge files together, display reports of the test results and compare different result files. -For details, see :yocto_wiki:`/wiki/Resulttool`. +For details, see :yocto_wiki:`/Resulttool`. run-config Target Execution =========================== --2.26.2
Re: [docs] [PATCH 1/3] documentation: Simplify yocto_wiki links
Quoted 18 lines · Nicolas Dechesne
Quoted 8 lines · Paul Barker
The
yocto_wikiexternal link directive is modified to include the/wikielement of the URL so that we can simplify the links in the text.Note that there are still a couple of places where this directive cannot be used, such as in the table of contents in
index.rst.Quoted 7 lines
Signed-off-by Paul Barker <[email protected]>--- .../brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 2 +- documentation/bsp-guide/bsp.rst | 2 +- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 14 +++++++------- documentation/dev-manual/dev-manual-start.rst | 2 +-
Quoted 7 lines
You missed one instance in
dev-manual-start.rst:For a "map" of Yocto Project releases to version numbers, see
the
:yocto_wiki:Releases </wiki/Releases>wiki page.I found it with make linkcheck
There's always one that gets away!
Also, TIL about make linkcheck. I'll add that to the readme as a recommendation before sending patches if you've added/modified links.
Signature · 2 lines
Paul Barker Konsulko Group
PATCH 2/3 documentation: Simplify yocto_git links
In reply to Paul BarkerThe yocto_git external link directive is modified to include the /cgit/cgit.cgi element of the URL so that we can simplify the links in the text.
Manual links to git.yoctoproject.org are converted to use the yocto_git directive where possible. Note that this directive can't be used in some places such as example code.
--- documentation/bsp-guide/bsp.rst | 21 +++++----- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 39 +++++++++---------- documentation/dev-manual/dev-manual-start.rst | 4 +- .../kernel-dev/kernel-dev-advanced.rst | 4 +- .../kernel-dev/kernel-dev-maint-appx.rst | 4 +- .../overview-manual-concepts.rst | 17 ++++---- ...verview-manual-development-environment.rst | 7 ++-- .../overview-manual-yp-intro.rst | 12 +++--- documentation/ref-manual/migration-1.3.rst | 2 +- documentation/ref-manual/migration-1.6.rst | 2 +- documentation/ref-manual/migration-2.2.rst | 4 +- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/migration-2.5.rst | 6 +-- documentation/ref-manual/migration-3.0.rst | 2 +- documentation/ref-manual/ref-classes.rst | 2 +- .../ref-manual/ref-devtool-reference.rst | 4 +- documentation/ref-manual/ref-tasks.rst | 2 +- documentation/ref-manual/ref-terms.rst | 4 +- documentation/ref-manual/ref-variables.rst | 2 +- .../test-manual/test-manual-intro.rst | 4 +- .../test-manual/test-manual-test-process.rst | 6 +-- .../toaster-manual-reference.rst | 15 +++---- .../toaster-manual-setup-and-use.rst | 4 +- 24 files changed, 80 insertions(+), 91 deletions(-)
documentation/bsp-guide/bsp.rst +10 -11
@@ -172,8 +172,7 @@ section. #. *Optionally Clone the meta-intel BSP Layer:* If your hardware is based on current Intel CPUs and devices, you can leverage this BSP layer. For details on the ``meta-intel`` BSP layer, see the layer's - `README <http://git.yoctoproject.org/cgit/cgit.cgi/meta-intel/tree/README>`__ - file. + :yocto_git:`README </meta-intel/tree/README>` file. #. *Navigate to Your Source Directory:* Typically, you set up the ``meta-intel`` Git repository inside the :term:`Source Directory` (e.g.
@@ -902,13 +901,13 @@ Yocto Project: ``meta-bsp_root_name`` directory. This license covers the BSP Metadata as a whole. You must specify which license to use since no default license exists when one is not specified. See the - :yocto_git:`COPYING.MIT </cgit.cgi/meta-raspberrypi/tree/COPYING.MIT>` + :yocto_git:`COPYING.MIT </meta-raspberrypi/tree/COPYING.MIT>` file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer as an example. - *README File:* You must include a ``README`` file in the ``meta-bsp_root_name`` directory. See the - :yocto_git:`README.md </cgit.cgi/meta-raspberrypi/tree/README.md>` + :yocto_git:`README.md </meta-raspberrypi/tree/README.md>` file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer as an example.
@@ -1181,16 +1180,16 @@ Use these steps to create a BSP layer: :yocto_git:`Source Repositories <>`. To get examples of what you need in your configuration file, locate a layer (e.g. "meta-ti") and examine the - :yocto_git:`local.conf </cgit/cgit.cgi/meta-ti/tree/conf/layer.conf>` + :yocto_git:`local.conf </meta-ti/tree/conf/layer.conf>` file. - *Create a Machine Configuration File:* Create a ``conf/machine/bsp_root_name.conf`` file. See - :yocto_git:`meta-yocto-bsp/conf/machine </cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf/machine>` + :yocto_git:`meta-yocto-bsp/conf/machine </poky/tree/meta-yocto-bsp/conf/machine>` for sample ``bsp_root_name.conf`` files. Other samples such as - :yocto_git:`meta-ti </cgit/cgit.cgi/meta-ti/tree/conf/machine>` + :yocto_git:`meta-ti </meta-ti/tree/conf/machine>` and - :yocto_git:`meta-freescale </cgit/cgit.cgi/meta-freescale/tree/conf/machine>` + :yocto_git:`meta-freescale </meta-freescale/tree/conf/machine>` exist from other vendors that have more specific machine and tuning examples.
@@ -1204,7 +1203,7 @@ Use these steps to create a BSP layer: The remainder of this section provides a description of the Yocto Project reference BSP for Beaglebone, which resides in the -:yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/poky/tree/meta-yocto-bsp>` +:yocto_git:`meta-yocto-bsp </poky/tree/meta-yocto-bsp>` layer. BSP Layer Configuration Example
@@ -1413,7 +1412,7 @@ Project Reference Manual. .. note:: For more information on how the SPL variables are used, see the - :yocto_git:`u-boot.inc </cgit/cgit.cgi/poky/tree/meta/recipes-bsp/u-boot/u-boot.inc>` + :yocto_git:`u-boot.inc </poky/tree/meta/recipes-bsp/u-boot/u-boot.inc>` include file. - :term:`UBOOT_* <UBOOT_ENTRYPOINT>`: Defines
@@ -1457,7 +1456,7 @@ The ``meta-yocto-bsp/recipes-kernel/linux`` directory in the layer contains metadata used to build the kernel. In this case, a kernel append file (i.e. ``linux-yocto_5.0.bbappend``) is used to override an established kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in -:yocto_git:`/cgit/cgit.cgi/poky/tree/meta/recipes-kernel/linux`. +:yocto_git:`/poky/tree/meta/recipes-kernel/linux`. Following is the contents of the append file: ::
documentation/conf.py +1 -1
@@ -75,7 +75,7 @@ extlinks = { 'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None), 'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None), 'yocto_docs': ('https://docs.yoctoproject.org%s', None), - 'yocto_git': ('https://git.yoctoproject.org%s', None), + 'yocto_git': ('https://git.yoctoproject.org/cgit/cgit.cgi%s', None), 'oe_home': ('https://www.openembedded.org%s', None), 'oe_lists': ('https://lists.openembedded.org%s', None), 'oe_git': ('https://git.openembedded.org%s', None),
documentation/dev-manual/dev-manual-common-tasks.rst +18 -21
@@ -75,7 +75,7 @@ Follow these general steps to create your layer without using tools: ``conf`` directory and then modify the file as needed. The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project - :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf>` + :yocto_git:`Source Repositories </poky/tree/meta-yocto-bsp/conf>` demonstrates the required syntax. For your layer, you need to replace "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz" for a layer named "meta-machinexyz"):
@@ -2107,15 +2107,12 @@ being able to provide the ``virtual/kernel`` item. Now comes the time to actually build an image and you need a kernel recipe, but which one? You can configure your build to call out the -kernel recipe you want by using the -:term:`PREFERRED_PROVIDER` -variable. As an example, consider the -`x86-base.inc <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`_ -include file, which is a machine (i.e. -:term:`MACHINE`) configuration file. -This include file is the reason all x86-based machines use the -``linux-yocto`` kernel. Here are the relevant lines from the include -file: +kernel recipe you want by using the :term:`PREFERRED_PROVIDER` variable. As +an example, consider the :yocto_git:`x86-base.inc +</poky/tree/meta/conf/machine/include/x86-base.inc>` include file, which is a +machine (i.e. :term:`MACHINE`) configuration file. This include file is the +reason all x86-based machines use the ``linux-yocto`` kernel. Here are the +relevant lines from the include file: :: PREFERRED_PROVIDER_virtual/kernel ??= "linux-yocto"
@@ -3058,7 +3055,7 @@ The following steps describe how to set up the AUH utility: 7. *Create and Edit an AUH Configuration File:* You need to have the ``upgrade-helper/upgrade-helper.conf`` configuration file in your build directory. You can find a sample configuration file in the - :yocto_git:`AUH source repository </cgit/cgit.cgi/auto-upgrade-helper/tree/>`. + :yocto_git:`AUH source repository </auto-upgrade-helper/tree/>`. Read through the sample file and make configurations as needed. For example, if you enabled build history in your ``local.conf`` as
@@ -3122,7 +3119,7 @@ the layer tree. You can easily set up to run the AUH utility on a regular basis by using a cron job. See the -:yocto_git:`weeklyjob.sh </cgit/cgit.cgi/auto-upgrade-helper/tree/weeklyjob.sh>` +:yocto_git:`weeklyjob.sh </auto-upgrade-helper/tree/weeklyjob.sh>` file distributed with the utility for an example. Using ``devtool upgrade``
@@ -4362,9 +4359,9 @@ your tunings to best consider build times and package feed maintenance. higher levels noted earlier can be useful. For example, consider how NXP (formerly Freescale) allows for the easy reuse of binary packages in their layer - :yocto_git:`meta-freescale </cgit/cgit.cgi/meta-freescale/>`. + :yocto_git:`meta-freescale </meta-freescale/>`. In this example, the - :yocto_git:`fsl-dynamic-packagearch </cgit/cgit.cgi/meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>` + :yocto_git:`fsl-dynamic-packagearch </meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>` class shares GPU packages for i.MX53 boards because all boards share the AMD GPU. The i.MX6-based boards can do the same because all boards share the Vivante GPU. This class inspects the BitBake
@@ -5564,7 +5561,7 @@ partition. Source plugins are subclasses defined in plugin files. As shipped, the Yocto Project provides several plugin files. You can see the source plugin files that ship with the Yocto Project -:yocto_git:`here </cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source>`. +:yocto_git:`here </poky/tree/scripts/lib/wic/plugins/source>`. Each of these plugin files contains source plugins that are designed to populate a specific Wic image partition.
@@ -6175,7 +6172,7 @@ system to make your images more secure: - Consider enabling a Mandatory Access Control (MAC) framework such as SMACK or SELinux and tuning it appropriately for your device's usage. You can find more information in the - :yocto_git:`meta-selinux </cgit/cgit.cgi/meta-selinux/>` layer. + :yocto_git:`meta-selinux </meta-selinux/>` layer. Tools for Hardening Your Image ------------------------------
@@ -8436,7 +8433,7 @@ might be significant in human-readable form. Here is an example: To see changes to the build history using a web interface, follow the instruction in the ``README`` file -:yocto_git:`here </cgit/cgit.cgi/buildhistory-web/>`. +:yocto_git:`here </buildhistory-web/>`. Here is a sample screenshot of the interface:
@@ -9511,7 +9508,7 @@ the build system to run the task again. For an example of a commit that makes a cosmetic change to invalidate shared state, see this - :yocto_git:`commit </cgit.cgi/poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54>`. + :yocto_git:`commit </poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54>`. Running Specific Tasks ----------------------
@@ -10475,7 +10472,7 @@ used testing branches for OpenEmbedded-Core are as follows: proposed changes to the core metadata. - *poky "master-next" branch:* This branch is part of the - :yocto_git:`poky </cgit/cgit.cgi/poky/>` repository and combines proposed + :yocto_git:`poky </poky/>` repository and combines proposed changes to bitbake, the core metadata and the poky distro. Similarly, stable branches maintained by the project may have corresponding
@@ -11381,7 +11378,7 @@ this function, you have to follow the following steps: SPDX_DEPLOY_DIR = "${DEPLOY_DIR}" //Optional For more usage information refer to :yocto_git:`the meta-spdxscanner repository -</cgit/cgit.cgi/meta-spdxscanner/>`. +</meta-spdxscanner/>`. Copying Licenses that Do Not Exist
@@ -11487,7 +11484,7 @@ Setting Up Your Own Error Reporting Server ------------------------------------------ If you want to set up your own error reporting server, you can obtain -the code from the Git repository at :yocto_git:`/cgit/cgit.cgi/error-report-web/`. +the code from the Git repository at :yocto_git:`/error-report-web/`. Instructions on how to set it up are in the README document. Using Wayland and Weston
documentation/dev-manual/dev-manual-start.rst +2 -2
@@ -586,7 +586,7 @@ Working from a copy of the upstream :ref:`dev-manual/dev-manual-start:accessing preferred method for obtaining and using a Yocto Project release. You can view the Yocto Project Source Repositories at :yocto_git:`/`. In particular, you can find the ``poky`` -repository at :yocto_git:`/cgit.cgi/poky`. +repository at :yocto_git:`/poky`. Use the following procedure to locate the latest upstream copy of the ``poky`` Git repository:
@@ -600,7 +600,7 @@ Use the following procedure to locate the latest upstream copy of the 3. *Find the URL Used to Clone the Repository:* At the bottom of the page, note the URL used to clone that repository - (e.g. :yocto_git:`/cgit.cgi/poky`). + (e.g. :yocto_git:`/poky`). .. note::
documentation/kernel-dev/kernel-dev-advanced.rst +2 -2
@@ -200,7 +200,7 @@ either :term:`FILESEXTRAPATHS` if you are creating Metadata in `recipe-space <#recipe-space-metadata>`__, or the top level of -:yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache/tree/>` +:yocto_git:`yocto-kernel-cache </yocto-kernel-cache/tree/>` if you are creating `Metadata outside of the recipe-space <#metadata-outside-the-recipe-space>`__.
@@ -469,7 +469,7 @@ supported kernel type. For BSPs supported by the Yocto Project, the BSP description files are located in the ``bsp`` directory of the ``yocto-kernel-cache`` repository organized under the "Yocto Linux Kernel" heading in the - :yocto_git:`Yocto Project Source Repositories </>`. + :yocto_git:`Yocto Project Source Repositories <>`. This section overviews the BSP description structure, the aggregation concepts, and presents a detailed example using a BSP supported by the
documentation/kernel-dev/kernel-dev-maint-appx.rst +2 -2
@@ -103,7 +103,7 @@ patch, or BSP: located by searching these system directories: - The in-tree kernel-cache directories, which are located in the - :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache/tree/bsp>` + :yocto_git:`yocto-kernel-cache </yocto-kernel-cache/tree/bsp>` repository organized under the "Yocto Linux Kernel" heading in the :yocto_git:`Yocto Project Source Repositories <>`.
@@ -167,7 +167,7 @@ specific to some target hardware. The end result is a branched, clean history tree that makes up the kernel for a given release. You can see the script (``kgit-scc``) responsible for this in the - :yocto_git:`yocto-kernel-tools </cgit.cgi/yocto-kernel-tools/tree/tools>` + :yocto_git:`yocto-kernel-tools </yocto-kernel-tools/tree/tools>` repository. - The steps used to construct the full kernel tree are the same
documentation/overview-manual/overview-manual-concepts.rst +8 -9
@@ -273,7 +273,7 @@ The ``local.conf`` file provides many basic variables that define a build environment. Here is a list of a few. To see the default configurations in a ``local.conf`` file created by the build environment script, see the -:yocto_git:`local.conf.sample </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>` +:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/local.conf.sample>` in the ``meta-poky`` layer: - *Target Machine Selection:* Controlled by the
@@ -393,17 +393,17 @@ figure <#general-workflow-figure>`__: configurations. This type of information is specific to a particular target architecture. A good example of a BSP layer from the `Poky Reference Distribution <#gs-reference-distribution-poky>`__ is the - :yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/poky/tree/meta-yocto-bsp>` + :yocto_git:`meta-yocto-bsp </poky/tree/meta-yocto-bsp>` layer. - *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in the following figure) providing top-level or general policies for the images or SDKs being built for a particular distribution. For example, in the Poky Reference Distribution the distro layer is the - :yocto_git:`meta-poky </cgit/cgit.cgi/poky/tree/meta-poky>` + :yocto_git:`meta-poky </poky/tree/meta-poky>` layer. Within the distro layer is a ``conf/distro`` directory that contains distro configuration files (e.g. - :yocto_git:`poky.conf </cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>` + :yocto_git:`poky.conf </poky/tree/meta-poky/conf/distro/poky.conf>` that contain many policy configurations for the Poky distribution. The following figure shows an expanded representation of these three
@@ -427,9 +427,8 @@ Model <#the-yocto-project-layer-model>`__" sections both earlier in this manual. If you explored the previous links, you discovered some areas where many -layers that work with the Yocto Project exist. The `Source -Repositories <http://git.yoctoproject.org/>`__ also shows layers -categorized under "Yocto Metadata Layers." +layers that work with the Yocto Project exist. The :yocto_git:`Source +Repositories <>` also shows layers categorized under "Yocto Metadata Layers." .. note::
@@ -879,7 +878,7 @@ This step in the build process consists of the following tasks: variables. For information on how this variable works within that class, see the :ref:`autotools <ref-classes-autotools>` class - :yocto_git:`here </cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`. + :yocto_git:`here </poky/tree/meta/classes/autotools.bbclass>`. - *do_compile*: Once a configuration task has been satisfied, BitBake compiles the source using the
@@ -957,7 +956,7 @@ The :term:`FILES` variable defines the files that go into each package in :term:`PACKAGES`. If you want details on how this is accomplished, you can look at -:yocto_git:`package.bbclass </cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`. +:yocto_git:`package.bbclass </poky/tree/meta/classes/package.bbclass>`. Depending on the type of packages being created (RPM, DEB, or IPK), the :ref:`do_package_write_* <ref-tasks-package_write_deb>`
documentation/overview-manual/overview-manual-development-environment.rst +3 -4
@@ -416,7 +416,7 @@ files. Git uses "branches" to organize different development efforts. For example, the ``poky`` repository has several branches that include the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many branches for past Yocto Project releases. You can see all the branches -by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the +by going to :yocto_git:`/poky/` and clicking on the ``[...]`` link beneath the "Branch" heading. Each of these branches represents a specific area of development. The
@@ -461,9 +461,8 @@ Yocto Project Release. Git uses "tags" to mark specific changes in a repository branch structure. Typically, a tag is used to mark a special point such as the final change (or commit) before a project is released. You can see the -tags used with the ``poky`` Git repository by going to -https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link -beneath the "Tag" heading. +tags used with the ``poky`` Git repository by going to :yocto_git:`/poky/` +and clicking on the ``[...]`` link beneath the "Tag" heading. Some key tags for the ``poky`` repository are ``jethro-14.0.3``, ``morty-16.0.1``, ``pyro-17.0.0``, and
documentation/overview-manual/overview-manual-yp-intro.rst +5 -7
@@ -267,9 +267,8 @@ with the string ``meta-``. , but it is a commonly accepted standard in the Yocto Project community. -For example, if you were to examine the `tree -view <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/>`__ of the -``poky`` repository, you will see several layers: ``meta``, +For example, if you were to examine the :yocto_git:`tree view </poky/tree/>` +of the ``poky`` repository, you will see several layers: ``meta``, ``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and ``meta-yocto-bsp``. Each of these repositories represents a distinct layer.
@@ -467,7 +466,7 @@ The following list consists of components associated with the OpenEmbedded-derived systems, which includes the Yocto Project. The Yocto Project and the OpenEmbedded Project both maintain the OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto - Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta>`. + Project :yocto_git:`Source Repositories </poky/tree/meta>`. Historically, the Yocto Project integrated the OE-Core metadata throughout the Yocto Project source repository reference system
@@ -671,7 +670,7 @@ Poky is a combined repository of BitBake, OpenEmbedded-Core (which is found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation provided all together and known to work well together. You can view these items that make up the Poky repository in the -:yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/>`. +:yocto_git:`Source Repositories </poky/tree/>`. .. note::
@@ -870,8 +869,7 @@ helpful for getting started: set of recipes. You can see the Metadata in the ``meta`` directory of the Yocto - Project `Source - Repositories <http://git.yoctoproject.org/cgit/cgit.cgi>`__. + Project :yocto_git:`Source Repositories <>`. - *Packages:* In the context of the Yocto Project, this term refers to a recipe's packaged output produced by BitBake (i.e. a "baked
documentation/ref-manual/migration-1.3.rst +1 -1
@@ -173,7 +173,7 @@ the OpenEmbedded community layers such as ``meta-oe`` and ``meta-gnome``. For the remainder, you can now find them in the ``meta-extras`` repository, which is in the :yocto_git:`Source Repositories <>` at -:yocto_git:`/cgit/cgit.cgi/meta-extras/`. +:yocto_git:`/meta-extras/`. .. _1.3-linux-kernel-naming:
documentation/ref-manual/migration-1.6.rst +1 -1
@@ -411,6 +411,6 @@ The previous reference BSPs for the ``beagleboard`` and ``routerstationpro`` machines are still available in a new ``meta-yocto-bsp-old`` layer in the :yocto_git:`Source Repositories <>` at -:yocto_git:`/cgit/cgit.cgi/meta-yocto-bsp-old/`. +:yocto_git:`/meta-yocto-bsp-old/`.
documentation/ref-manual/migration-2.2.rst +2 -2
@@ -292,9 +292,9 @@ The following changes took place for BitBake: functionality. These changes will affect external tools that use BitBake's tinfoil module. For information on these changes, see the changes made to the scripts supplied with OpenEmbedded-Core: - `1 <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee>`__ + :yocto_git:`1 </poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee>` and - `2 <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67>`__. + :yocto_git:`2 </poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67>`. - The task management code has been rewritten to avoid using ID indirection in order to improve performance. This change is unlikely
documentation/ref-manual/migration-2.3.rst +1 -1
@@ -323,7 +323,7 @@ The following package management changes took place: .. note:: For further details on this change, see the - :yocto_git:`commit message </cgit/cgit.cgi/poky/commit/?id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81>`. + :yocto_git:`commit message </poky/commit/?id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81>`. .. _migration-2.3-removed-recipes:
documentation/ref-manual/migration-2.5.rst +3 -3
@@ -180,7 +180,7 @@ or :: The earlier build-time provides behavior was a quirk of the way the Python manifest file was created. For more information on this change please see :yocto_git:`this commit -</cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`. +</poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`. .. _migration-2.5-miscellaneous-changes:
@@ -293,8 +293,8 @@ The following are additional changes: - Patches whose context does not match exactly (i.e. where patch reports "fuzz" when applying) will generate a warning. For an example - of this see `this - commit <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57>`__. + of this see :yocto_git:`this commit + </poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57>`. - Layers are expected to set ``LAYERSERIES_COMPAT_layername`` to match the version(s) of OpenEmbedded-Core they are compatible with. This is
documentation/ref-manual/migration-3.0.rst +1 -1
@@ -197,7 +197,7 @@ The following BitBake changes have occurred. - The arguments passed to functions used with :term:`bitbake:BB_HASHCHECK_FUNCTION` have changed. If you are using your own custom hash check function, - see :yocto_git:`/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` + see :yocto_git:`/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` for details. - Task specifications in ``BB_TASKDEPDATA`` and class implementations
documentation/ref-manual/ref-classes.rst +1 -1
@@ -2774,7 +2774,7 @@ To use this class, you need to define a number of variables: These variables list alternative commands needed by a package, provide pathnames for links, default links for targets, and so forth. For details on how to use this class, see the comments in the -:yocto_git:`update-alternatives.bbclass </cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass>` +:yocto_git:`update-alternatives.bbclass </poky/tree/meta/classes/update-alternatives.bbclass>` file. .. note::
documentation/ref-manual/ref-devtool-reference.rst +2 -2
@@ -349,7 +349,7 @@ particular recipe. .. note:: - For the ``oe-core`` layer, recipe maintainers come from the - `maintainers.inc <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc>`_ + :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` file. - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)`
@@ -388,7 +388,7 @@ satisfied. When a reason for not upgrading displays, the reason is usually written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` variable. See the - :yocto_git:`base-passwd.bb </cgit/cgit.cgi/poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` + :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` recipe for an example. ::
documentation/ref-manual/ref-tasks.rst +1 -1
@@ -301,7 +301,7 @@ to locate and apply patch files to the source code. Patch files, by default, are ``*.patch`` and ``*.diff`` files created and kept in a subdirectory of the directory holding the recipe file. For example, consider the -:yocto_git:`bluez5 </cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>` +:yocto_git:`bluez5 </poky/tree/meta/recipes-connectivity/bluez5>` recipe from the OE-Core layer (i.e. ``poky/meta``): ::
documentation/ref-manual/ref-terms.rst +2 -2
@@ -218,7 +218,7 @@ universal, the list includes them just in case: In the context of the kernel ("kernel Metadata"), the term refers to the kernel config fragments and features contained in the - :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache>` + :yocto_git:`yocto-kernel-cache </yocto-kernel-cache>` Git repository. :term:`OpenEmbedded-Core (OE-Core)`
@@ -232,7 +232,7 @@ universal, the list includes them just in case: core set of recipes. You can see the Metadata in the ``meta`` directory of the Yocto - Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky>`. + Project :yocto_git:`Source Repositories </poky>`. :term:`OpenEmbedded Build System` The build system specific to the Yocto
documentation/ref-manual/ref-variables.rst +1 -1
@@ -3600,7 +3600,7 @@ system and gives an overview of their function and contents. configuration file. You cannot set the variable in a recipe file. See the - :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>` + :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>` file for additional information. Also, for information on creating an initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual.
documentation/test-manual/test-manual-intro.rst +2 -2
@@ -25,14 +25,14 @@ loaded with information from the README files and notes from key engineers: - *yocto-autobuilder2:* This - :yocto_git:`README.md </cgit.cgi/yocto-autobuilder2/tree/README.md>` + :yocto_git:`README.md </yocto-autobuilder2/tree/README.md>` is the main README which detials how to set up the Yocto Project Autobuilder. The ``yocto-autobuilder2`` repository represents the Yocto Project's console UI plugin to Buildbot and the configuration necessary to configure Buildbot to perform the testing the project requires. -- *yocto-autobuilder-helper:* This :yocto_git:`README </cgit.cgi/yocto-autobuilder-helper/tree/README/>` +- *yocto-autobuilder-helper:* This :yocto_git:`README </yocto-autobuilder-helper/tree/README/>` and repository contains Yocto Project Autobuilder Helper scripts and configuration. The ``yocto-autobuilder-helper`` repository contains the "glue" logic that defines which tests to run and how to run them.
documentation/test-manual/test-manual-test-process.rst +3 -3
@@ -35,9 +35,9 @@ which the result was required. The Autobuilder does build the ``master`` branch once daily for several reasons, in particular, to ensure the current ``master`` branch does build, but also to keep ``yocto-testresults`` -(:yocto_git:`/cgit.cgi/yocto-testresults/`), +(:yocto_git:`/yocto-testresults/`), buildhistory -(:yocto_git:`/cgit.cgi/poky-buildhistory/`), and +(:yocto_git:`/poky-buildhistory/`), and our sstate up to date. On the weekend, there is a master-next build instead to ensure the test results are updated for the less frequently run targets.
@@ -45,7 +45,7 @@ run targets. Performance builds (buildperf-\* targets in the console) are triggered separately every six hours and automatically push their results to the buildstats repository at: -:yocto_git:`/cgit.cgi/yocto-buildstats/`. +:yocto_git:`/yocto-buildstats/`. The 'quick' targets have been selected to be the ones which catch the most failures or give the most valuable data. We run 'fast' ptests in
documentation/toaster-manual/toaster-manual-reference.rst +6 -9
@@ -25,8 +25,7 @@ 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 -layer index's web application at -http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/. +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
@@ -83,9 +82,8 @@ index. In the previous section, the code for the OpenEmbedded Metadata Index (i.e. http://layers.openembedded.org) was referenced. You can use -this code, which is at -http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/, as a -base to create your own layer index. +this code, which is at :yocto_git:`/layerindex-web/`, as a base to create +your own layer index. Use the Administration Interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -165,14 +163,13 @@ As shipped, Toaster is configured to work with the following releases: - *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":* This release causes your Toaster projects to build against the head of the &DISTRO_NAME_NO_CAP; branch at - https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP; or - http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;. + :yocto_git:`/poky/log/?h=&DISTRO_NAME_NO_CAP;` or + :oe_git:`/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;`. - *Yocto Project "Master" or OpenEmbedded "Master":* This release causes your Toaster Projects to build against the head of the master branch, which is where active development takes place, at - https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or - http://git.openembedded.org/openembedded-core/log/. + :yocto_git:`/poky/log/` or :oe_git:`/openembedded-core/log/`. - *Local Yocto Project or Local OpenEmbedded:* This release causes your Toaster Projects to build against the head of the ``poky`` or
documentation/toaster-manual/toaster-manual-setup-and-use.rst +2 -2
@@ -561,8 +561,8 @@ the same clone you are using to run Toaster. Unless you manually update this clone, your builds will always use the same Git revision. If you select any of the other release options, Toaster will fetch the -tip of your selected release from the upstream `Yocto Project -repository <https://git.yoctoproject.org>`__ every time you run a build. +tip of your selected release from the upstream :yocto_git:`Yocto Project +repository <>` every time you run a build. Fetching this tip effectively means that if your selected release is updated upstream, the Git revision you are using for your builds will change. If you are doing development locally, you might not want this
Signature · 1 line
2.26.2
Re: [docs] [PATCH 2/3] documentation: Simplify yocto_git links
Quoted 42 lines · Paul Barker
The
yocto_gitexternal link directive is modified to include the/cgit/cgit.cgielement of the URL so that we can simplify the links in the text.Manual links to git.yoctoproject.org are converted to use the
yocto_gitdirective where possible. Note that this directive can't be used in some places such as example code.Signed-off-by Paul Barker <[email protected]>--- documentation/bsp-guide/bsp.rst | 21 +++++----- documentation/conf.py | 2 +- .../dev-manual/dev-manual-common-tasks.rst | 39 +++++++++---------- documentation/dev-manual/dev-manual-start.rst | 4 +- .../kernel-dev/kernel-dev-advanced.rst | 4 +- .../kernel-dev/kernel-dev-maint-appx.rst | 4 +- .../overview-manual-concepts.rst | 17 ++++---- ...verview-manual-development-environment.rst | 7 ++-- .../overview-manual-yp-intro.rst | 12 +++--- documentation/ref-manual/migration-1.3.rst | 2 +- documentation/ref-manual/migration-1.6.rst | 2 +- documentation/ref-manual/migration-2.2.rst | 4 +- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/migration-2.5.rst | 6 +-- documentation/ref-manual/migration-3.0.rst | 2 +- documentation/ref-manual/ref-classes.rst | 2 +- .../ref-manual/ref-devtool-reference.rst | 4 +- documentation/ref-manual/ref-tasks.rst | 2 +- documentation/ref-manual/ref-terms.rst | 4 +- documentation/ref-manual/ref-variables.rst | 2 +- .../test-manual/test-manual-intro.rst | 4 +- .../test-manual/test-manual-test-process.rst | 6 +-- .../toaster-manual-reference.rst | 15 +++---- .../toaster-manual-setup-and-use.rst | 4 +- 24 files changed, 80 insertions(+), 91 deletions(-)documentation/bsp-guide/bsp.rst +0
-0
documentation/bsp-guide/bsp.rst section. · line 175
Quoted 6 lines
documentation/bsp-guide/bsp.rst +1
-2@@ -172,8 +172,7 @@ section. #. *Optionally Clone the meta-intel BSP Layer:* If your hardware is based on current Intel CPUs and devices, you can leverage this BSP layer. For details on the ``meta-intel`` BSP layer, see the layer's - `README <http://git.yoctoproject.org/cgit/cgit.cgi/meta-intel/tree/README>`__ - file. + :yocto_git:`README </meta-intel/tree/README>` file.
Same question here, as with :yocto_wiki:, can we get rid of the 'leading' / ?
Quoted 12 lines
documentation/bsp-guide/bsp.rst +1
-1#. *Navigate to Your Source Directory:* Typically, you set up the ``meta-intel`` Git repository inside the :term:`Source Directory` (e.g.@@ -902,13 +901,13 @@ Yocto Project: ``meta-bsp_root_name`` directory. This license covers the BSP Metadata as a whole. You must specify which license to use since no default license exists when one is not specified. See the - :yocto_git:`COPYING.MIT </cgit.cgi/meta-raspberrypi/tree/COPYING.MIT>` + :yocto_git:`COPYING.MIT </meta-raspberrypi/tree/COPYING.MIT>` file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer as an example.
PATCH 3/3 ref-manual: Simplify oe_git links
In reply to Paul BarkerManual links to git.openembedded.org are converted to use the oe_git directive where possible. Note that this directive can't be used in some places such as example code.
--- documentation/ref-manual/migration-1.5.rst | 2 +- documentation/ref-manual/migration-1.7.rst | 4 ++-- documentation/ref-manual/migration-1.8.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-)
documentation/ref-manual/migration-1.5.rst +1 -1
@@ -181,7 +181,7 @@ The following changes have been made that relate to The ``/run`` directory from the Filesystem Hierarchy Standard 3.0 has been introduced. You can find some of the implications for this change -`here <http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873>`__. +:oe_git:`here </openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873>`. The change also means that recipes that install files to ``/var/run`` must be changed. You can find a guide on how to make these changes `here <https://www.mail-archive.com/[email protected]/msg31649.html>`__.
documentation/ref-manual/migration-1.7.rst +2 -2
@@ -66,8 +66,8 @@ occurred: foreign mode themselves, the option is mostly superfluous. However, some recipes will need patches for this change. You can easily make the change by patching ``configure.ac`` so that it passes "foreign" - to ``AM_INIT_AUTOMAKE()``. See `this - commit <http://cgit.openembedded.org/openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2>`__ + to ``AM_INIT_AUTOMAKE()``. See :oe_git:`this + commit </openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2>` for an example showing how to make the patch. .. _migration-1.7-binary-configuration-scripts-disabled:
documentation/ref-manual/migration-1.8.rst +1 -1
@@ -79,7 +79,7 @@ particular, users need to ensure that ``${S}`` (source files) and inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the kinds of changes you need to make. For reference, here is the -`commit <http://cgit.openembedded.org/meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>`__ +:oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` where the ``linux.inc`` file in ``meta-oe`` was updated. Recipes that rely on the kernel source code and do not inherit the
Signature · 1 line
2.26.2