mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-03 01:40:07 +00:00
Code Issues Projects Releases Wiki Activity

sphinx: add links for Yocto project website

Browse Source 
In DocBook, variables are used to create custom links (note that it is
not consistent everywhere, since some web addresses are still
hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL,
YOCTO_BUGS_URL and YOCTO_DL_URL..

In Sphinx they are replaced with extlinks.

(From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Nicolas Dechesne
2020-07-30 11:00:01 +02:00
committed by Richard Purdie
parent 26c5622bb5
commit 283ed72d48
27 changed files with 140 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/overview-manual/overview-manual-concepts.rst
+6 -6
View File
@@ -277,7 +277,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
```local.conf.sample`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>`__
:yocto_git:`local.conf.sample </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>`
in the ``meta-poky`` layer:
- *Target Machine Selection:* Controlled by the
@@ -397,17 +397,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
```meta-yocto-bsp`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`__
:yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/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
```meta-poky`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky>`__
:yocto_git:`meta-poky </cgit/cgit.cgi/poky/tree/meta-poky>`
layer. Within the distro layer is a ``conf/distro`` directory that
contains distro configuration files (e.g.
```poky.conf`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>`__
:yocto_git:`poky.conf </cgit/cgit.cgi/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
@@ -901,7 +901,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
`here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`__.
:yocto_git:`here </cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`.
- *``do_compile``*: Once a configuration task has been satisfied,
BitBake compiles the source using the
@@ -981,7 +981,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
```package.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`__.
:yocto_git:`package.bbclass </cgit/cgit.cgi/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
+12 -13
View File
@@ -143,7 +143,7 @@ Yocto Project Source Repositories
=================================
The Yocto Project team maintains complete source repositories for all
Yocto Project files at ` <&YOCTO_GIT_URL;>`__. This web-based source
Yocto Project files at :yocto_git:`/`. This web-based source
code browser is organized into categories by function such as IDE
Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the
interface, you can click on any particular item in the "Name" column and
@@ -155,7 +155,7 @@ history, and ultimately enhance the Yocto Project's tools, Board Support
Packages, and so forth.
For any supported release of Yocto Project, you can also go to the
`Yocto Project Website <&YOCTO_HOME_URL;>`__ and select the "DOWNLOADS"
:yocto_home:`Yocto Project Website <>` and select the "DOWNLOADS"
item from the "SOFTWARE" menu and get a released tarball of the ``poky``
repository, any supported BSP tarball, or Yocto Project tools. Unpacking
these tarballs gives you a snapshot of the released files.
@@ -176,7 +176,7 @@ these tarballs gives you a snapshot of the released files.
In summary, here is where you can get the project files needed for
development:
- `Source Repositories: <&YOCTO_GIT_URL;>`__ This area contains IDE
- :yocto_git:`Source Repositories: <>` This area contains IDE
Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and
Yocto Metadata Layers. You can create local copies of Git
repositories for each of these areas.
@@ -189,7 +189,7 @@ development:
Repositories <&YOCTO_DOCS_DEV_URL;#accessing-source-repositories>`__"
Section in the Yocto Project Development Tasks Manual.
- `Index of /releases: <&YOCTO_DL_URL;/releases/>`__ This is an index
- :yocto_dl:`Index of /releases: <releases>` This is an index
of releases such as Poky, Pseudo, installers for cross-development
toolchains, miscellaneous support and all released versions of Yocto
Project in the form of images or tarballs. Downloading and extracting
@@ -204,14 +204,13 @@ development:
Releases <&YOCTO_DOCS_DEV_URL;#accessing-index-of-releases>`__"
section in the Yocto Project Development Tasks Manual.
- *"DOWNLOADS" page for the*\ `Yocto Project
Website <&YOCTO_HOME_URL;>`__\ *:*
- *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:*
The Yocto Project website includes a "DOWNLOADS" page accessible
through the "SOFTWARE" menu that allows you to download any Yocto
Project release, tool, and Board Support Package (BSP) in tarball
form. The tarballs are similar to those found in the `Index of
/releases: <&YOCTO_DL_URL;/releases/>`__ area.
form. The tarballs are similar to those found in the
:yocto_dl:`Index of /releases: <releases>` area.
.. image:: figures/yp-download.png
:align: center
@@ -259,8 +258,8 @@ and so forth.
The Yocto Project ``poky`` Git repository also has an upstream
contribution Git repository named ``poky-contrib``. You can see all the
branches in this repository using the web interface of the `Source
Repositories <&YOCTO_GIT_URL;>`__ organized within the "Poky Support"
branches in this repository using the web interface of the
:yocto_git:`Source Repositories <>` organized within the "Poky Support"
area. These branches hold changes (commits) to the project that have
been submitted or committed by the Yocto Project development team and by
community members who contribute to the project. The maintainer
@@ -400,7 +399,7 @@ Repositories, Tags, and Branches
As mentioned briefly in the previous section and also in the "`Git
Workflows and the Yocto
Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto
Project maintains source repositories at ` <&YOCTO_GIT_URL;>`__. If you
Project maintains source repositories at :yocto_git:`/`. If you
look at this web-interface of the repositories, each item is a separate
Git repository.
@@ -432,7 +431,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 ` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the
by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the
``[...]`` link beneath the "Branch" heading.
Each of these branches represents a specific area of development. The
@@ -472,7 +471,7 @@ 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
` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the ``[...]`` link
https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link
beneath the "Tag" heading.
Some key tags for the ``poky`` repository are ``jethro-14.0.3``,
documentation/overview-manual/overview-manual-intro.rst
+2 -2
View File
@@ -66,8 +66,8 @@ Other Information
Because this manual presents information for many different topics,
supplemental information is recommended for full comprehension. For
additional introductory information on the Yocto Project, see the `Yocto
Project Website <&YOCTO_HOME_URL;>`__. If you want to build an image
additional introductory information on the Yocto Project, see the
:yocto_home:`Yocto Project Website <>`. If you want to build an image
with no knowledge of Yocto Project as a way of quickly testing it out,
see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document.
For a comprehensive list of links and other documentation, see the
documentation/overview-manual/overview-manual-yp-intro.rst
+7 -8
View File
@@ -47,8 +47,8 @@ Project:
system, software, and service vendors exist whose products and
services adopt and support the Yocto Project. For a look at the Yocto
Project community and the companies involved with the Yocto Project,
see the "COMMUNITY" and "ECOSYSTEM" tabs on the `Yocto
Project <&YOCTO_HOME_URL;>`__ home page.
see the "COMMUNITY" and "ECOSYSTEM" tabs on the
:yocto_home:`Yocto Project <>` home page.
- *Architecture Agnostic:* Yocto Project supports Intel, ARM, MIPS,
AMD, PPC and other architectures. Most ODMs, OSVs, and chip vendors
@@ -482,8 +482,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 `Source
Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta>`__.
Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta>`.
Historically, the Yocto Project integrated the OE-Core metadata
throughout the Yocto Project source repository reference system
@@ -543,8 +542,8 @@ targets:
applications that you can tailor to a specific, non-desktop platform
to enhance usability in constrained environments.
You can find the Matchbox source in the Yocto Project `Source
Repositories <&YOCTO_GIT_URL;>`__.
You can find the Matchbox source in the Yocto Project
:yocto_git:`Source Repositories <>`.
- *Opkg* Open PacKaGe management (opkg) is a lightweight package
management system based on the itsy package (ipkg) management system.
@@ -696,8 +695,8 @@ into a usable binary image.
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 `Source
Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/>`__.
these items that make up the Poky repository in the
:yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/>`.
.. note::