mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
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. (From yocto-docs rev: d8aa5f93d349f27db3d03a2c4bcc205649f45a8d) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
62c061968c
commit
8faafa99cc
|
@ -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``
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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),
|
||||
|
|
|
@ -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::
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
@ -678,7 +678,7 @@ Releases <#accessing-index-of-releases>`__" section.
|
|||
.. note::
|
||||
|
||||
For a "map" of Yocto Project releases to version numbers, see the
|
||||
:yocto_wiki:`Releases </wiki/Releases>` wiki page.
|
||||
:yocto_wiki:`Releases </Releases>` wiki page.
|
||||
|
||||
You can use the "RELEASE ARCHIVE" link to reveal a menu of all Yocto
|
||||
Project releases.
|
||||
|
|
|
@ -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.
|
||||
|
||||
::
|
||||
|
|
|
@ -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?
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
||||
|
|
|
@ -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
|
||||
=============================
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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:
|
||||
::
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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::
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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
|
||||
===========================
|
||||
|
|
Loading…
Reference in New Issue
Block a user