From 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 30 Jul 2020 11:00:01 +0200 Subject: sphinx: add links for Yocto project website 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/faq.rst | 13 ++++++------- documentation/ref-manual/migration.rst | 4 ++-- documentation/ref-manual/ref-classes.rst | 2 +- documentation/ref-manual/ref-images.rst | 4 ++-- documentation/ref-manual/ref-system-requirements.rst | 10 +++++----- documentation/ref-manual/ref-tasks.rst | 2 +- documentation/ref-manual/ref-terms.rst | 5 ++--- documentation/ref-manual/ref-variables.rst | 12 ++++++------ documentation/ref-manual/resources.rst | 20 ++++++++------------ 9 files changed, 33 insertions(+), 39 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 3e8127b927..dbd2aaf159 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -134,10 +134,9 @@ http://proxy.yoyodyne.com:18023/ # If you do not want to use proxy at all, set this to off. #use_proxy = on 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 "`Working -Behind a Network -Proxy <&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy>`__" Wiki -page. +various proxy types and configuring proxy servers, see the +":yocto_wiki:`Working Behind a Network Proxy `" +Wiki page. **Q:** What’s the difference between target and target\ ``-native``? @@ -332,9 +331,9 @@ redirect requests through proxy servers. .. note:: - You can find more information on the " - Working Behind a Network Proxy - " Wiki page. + You can find more information on the + ":yocto_wiki:`Working Behind a Network Proxy `" + Wiki page. **Q:** Can I get rid of build output so I can start over? diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst index 31959b2845..377932e2cf 100644 --- a/documentation/ref-manual/migration.rst +++ b/documentation/ref-manual/migration.rst @@ -1248,8 +1248,8 @@ The following reference BSPs changes occurred: The previous reference BSPs for the ``beagleboard`` and ``routerstationpro`` machines are still available in a new -``meta-yocto-bsp-old`` layer in the `Source -Repositories <&YOCTO_GIT_URL;>`__ at +``meta-yocto-bsp-old`` layer in the +:yocto_git:`Source Repositories <>` at http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/. Moving to the Yocto Project 1.7 Release diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index 4b4f3bac5a..ae5f0e40d1 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst @@ -2749,7 +2749,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 -```update-alternatives.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass>`__ +:yocto_git:`update-alternatives.bbclass ` file. .. note:: diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst index 4eba5cdf16..0e26e57155 100644 --- a/documentation/ref-manual/ref-images.rst +++ b/documentation/ref-manual/ref-images.rst @@ -40,8 +40,8 @@ Following is a list of supported recipes: Player `__ or `VMware Workstation `__. - For more information on this image, see the `Build - Appliance <&YOCTO_HOME_URL;/software-item/build-appliance/>`__ page + For more information on this image, see the :yocto_home:`Build + Appliance ` page on the Yocto Project website. - ``core-image-base``: A console-only image that fully supports the diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index 3144d303f8..a9a937b661 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst @@ -13,8 +13,8 @@ Rather, use this manual to find variable definitions, class descriptions, and so forth as needed during the course of using the Yocto Project. -For introductory information on the Yocto Project, see the `Yocto -Project Website <&YOCTO_HOME_URL;>`__ and the "`Yocto Project +For introductory information on the Yocto Project, see the +:yocto_home:`Yocto Project Website <>` and the "`Yocto Project Development Environment <&YOCTO_DOCS_OM_URL;#overview-development-environment>`__" chapter in the Yocto Project Overview and Concepts Manual. @@ -68,8 +68,8 @@ distributions: - If you encounter problems, please go to `Yocto Project Bugzilla <&YOCTO_BUGZILLA_URL;>`__ and submit a bug. We are interested in hearing about your experience. For information on - how to submit a bug, see the Yocto Project `Bugzilla wiki - page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__ + how to submit a bug, see the Yocto Project + :yocto_wiki:`Bugzilla wiki page ` and the "`Submitting a Defect Against the Yocto Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" section in the Yocto Project Development Tasks Manual. @@ -255,7 +255,7 @@ installer and automatically installs the tools for you: 1. Execute the ``install-buildtools`` script. Here is an example: $ cd poky $ scripts/install-buildtools --without-extended-buildtools \\ - --base-url YOCTO_DL_URL/releases/yocto \\ --release yocto-DISTRO \\ + --base-url https://downloads.yoctoproject.org/releases/yocto \\ --release yocto-DISTRO \\ --installer-version DISTRO During execution, the buildtools tarball will be downloaded, the diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 4bcd0a2d00..f56f7a993f 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst @@ -310,7 +310,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 -```bluez5`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>`__ +:yocto_git:`bluez5 ` recipe from the OE-Core layer (i.e. ``poky/meta``): poky/meta/recipes-connectivity/bluez5 This recipe has two patch files located here: poky/meta/recipes-connectivity/bluez5/bluez5 diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index eacc49fc3d..ec9f6d3948 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst @@ -213,7 +213,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-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache>`__ + :yocto_git:`yocto-kernel-cache ` Git repository. OpenEmbedded-Core (OE-Core) @@ -227,8 +227,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 `Source - Repositories `__. + Project :yocto_git:`Source Repositories <>`. OpenEmbedded Build System The build system specific to the Yocto diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index aa7f59f602..53e99a395a 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst @@ -1853,9 +1853,9 @@ 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 "`FAQ <#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server>`__" - chapter. You can also refer to the "`Working Behind a Network - Proxy <&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy>`__" Wiki - page. + chapter. You can also refer to the + ":yocto_wiki:`Working Behind a Network Proxy `" + Wiki page. DOC_COMPRESS When inheriting the :ref:`compress_doc ` @@ -3240,7 +3240,7 @@ system and gives an overview of their function and contents. recipe file. See the - ```local.conf.sample.extended`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>`__ + :yocto_git:`local.conf.sample.extended ` file for additional information. Also, for information on creating an initramfs, see the "`Building an Initial RAM Filesystem (initramfs) Image <&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image>`__" section @@ -3740,8 +3740,8 @@ 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 `Release - Name `__ (e.g. + For the list, use the Yocto Project + :yocto_wiki:`Release Name ` (e.g. DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the layer, use a space-separated list: LAYERSERIES_COMPAT_layer_root_name = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 50f2afae03..b443cbfb79 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -33,7 +33,7 @@ Yocto Project Bugzilla ====================== The Yocto Project uses its own implementation of -`Bugzilla <&YOCTO_BUGZILLA_URL;>`__ to track defects (bugs). +:yocto_bugs:`Bugzilla <>` to track defects (bugs). Implementations of Bugzilla work well for group development because they track bugs and code changes, can be used to communicate changes and problems with developers, can be used to submit and review patches, and @@ -52,11 +52,9 @@ against the Yocto Project, see the following: Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" section in the Yocto Project Development Tasks Manual. -- The Yocto Project `Bugzilla wiki - page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__ +- The Yocto Project :yocto_wiki:`Bugzilla wiki page ` -For information on Bugzilla in general, see -` `__. +For information on Bugzilla in general, see http://www.bugzilla.org/about/. .. _resources-mailinglist: @@ -109,11 +107,10 @@ Links and Related Documentation Here is a list of resources you might find helpful: -- `The Yocto Project website <&YOCTO_HOME_URL;>`__\ *:* The home site +- :yocto_home:`The Yocto Project Website <>`\ *:* The home site for the Yocto Project. -- `The Yocto Project Main Wiki - Page <&YOCTO_WIKI_URL;/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. @@ -182,12 +179,12 @@ Here is a list of resources you might find helpful: the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. -- `FAQ <&YOCTO_WIKI_URL;/wiki/FAQ>`__\ *:* A list of commonly asked +- :yocto_wiki:`FAQ `\ *:* A list of commonly asked questions and their answers. - *Release Notes:* Features, updates and known issues for the current release of the Yocto Project. To access the Release Notes, go to the - `Downloads <&YOCTO_HOME_URL;/software-overview/downloads/>`__ page on + :yocto_home:`Downloads ` page on the Yocto Project website and click on the "RELEASE INFORMATION" link for the appropriate release. @@ -195,8 +192,7 @@ 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. -- `Bugzilla Configuration and Bug Tracking Wiki - Page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__\ *:* +- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page `\ *:* Information on how to get set up and use the Yocto Project implementation of Bugzilla for logging and tracking Yocto Project defects. -- cgit v1.2.3-54-g00ecf