diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-30 11:00:01 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (patch) | |
tree | ee9bc44a1a2789a729632f4c0c436257fa477b8e /documentation/dev-manual/dev-manual-start.rst | |
parent | 26c5622bb5551e1ad61db1c20890579dfb6b87c2 (diff) | |
download | poky-283ed72d487ed78d4f8e0fcc17f635d6c212b7c6.tar.gz |
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 <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-start.rst')
-rw-r--r-- | documentation/dev-manual/dev-manual-start.rst | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst index 81fa7847e6..884d1286ef 100644 --- a/documentation/dev-manual/dev-manual-start.rst +++ b/documentation/dev-manual/dev-manual-start.rst | |||
@@ -92,7 +92,7 @@ particular working environment and set of practices. | |||
92 | 92 | ||
93 | It is relatively easy to set up Git services and create | 93 | It is relatively easy to set up Git services and create |
94 | infrastructure like | 94 | infrastructure like |
95 | `http://git.yoctoproject.org <&YOCTO_GIT_URL;>`__, which is based on | 95 | :yocto_git:`http://git.yoctoproject.org <>`, which is based on |
96 | server software called ``gitolite`` with ``cgit`` being used to | 96 | server software called ``gitolite`` with ``cgit`` being used to |
97 | generate the web interface that lets you view the repositories. The | 97 | generate the web interface that lets you view the repositories. The |
98 | ``gitolite`` software identifies users using SSH keys and allows | 98 | ``gitolite`` software identifies users using SSH keys and allows |
@@ -322,8 +322,7 @@ Project Build Host: | |||
322 | validation and their status, see the "`Supported Linux | 322 | validation and their status, see the "`Supported Linux |
323 | Distributions <&YOCTO_DOCS_REF_URL;#detailed-supported-distros>`__" | 323 | Distributions <&YOCTO_DOCS_REF_URL;#detailed-supported-distros>`__" |
324 | section in the Yocto Project Reference Manual and the wiki page at | 324 | section in the Yocto Project Reference Manual and the wiki page at |
325 | `Distribution | 325 | :yocto_wiki:`Distribution Support </wiki/Distribution_Support>`. |
326 | Support <&YOCTO_WIKI_URL;/wiki/Distribution_Support>`__. | ||
327 | 326 | ||
328 | 2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes | 327 | 2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes |
329 | of free disk space for building images. | 328 | of free disk space for building images. |
@@ -598,14 +597,14 @@ Working from a copy of the upstream Yocto Project `Source | |||
598 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the | 597 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the |
599 | preferred method for obtaining and using a Yocto Project release. You | 598 | preferred method for obtaining and using a Yocto Project release. You |
600 | can view the Yocto Project Source Repositories at | 599 | can view the Yocto Project Source Repositories at |
601 | ` <&YOCTO_GIT_URL;>`__. In particular, you can find the ``poky`` | 600 | :yocto_git:`/`. In particular, you can find the ``poky`` |
602 | repository at ` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__. | 601 | repository at :yocto_git:`/cgit.cgi/poky`. |
603 | 602 | ||
604 | Use the following procedure to locate the latest upstream copy of the | 603 | Use the following procedure to locate the latest upstream copy of the |
605 | ``poky`` Git repository: | 604 | ``poky`` Git repository: |
606 | 605 | ||
607 | 1. *Access Repositories:* Open a browser and go to | 606 | 1. *Access Repositories:* Open a browser and go to |
608 | ` <&YOCTO_GIT_URL;>`__ to access the GUI-based interface into the | 607 | :yocto_git:`/` to access the GUI-based interface into the |
609 | Yocto Project source repositories. | 608 | Yocto Project source repositories. |
610 | 609 | ||
611 | 2. *Select the Repository:* Click on the repository in which you are | 610 | 2. *Select the Repository:* Click on the repository in which you are |
@@ -614,7 +613,7 @@ Use the following procedure to locate the latest upstream copy of the | |||
614 | 3. *Find the URL Used to Clone the Repository:* At the bottom of the | 613 | 3. *Find the URL Used to Clone the Repository:* At the bottom of the |
615 | page, note the URL used to | 614 | page, note the URL used to |
616 | `clone <&YOCTO_DOCS_OM_URL;#git-commands-clone>`__ that repository | 615 | `clone <&YOCTO_DOCS_OM_URL;#git-commands-clone>`__ that repository |
617 | (e.g. ``YOCTO_GIT_URL/poky``). | 616 | (e.g. :yocto_git:`/git/poky`). |
618 | 617 | ||
619 | .. note:: | 618 | .. note:: |
620 | 619 | ||
@@ -642,7 +641,7 @@ of a given component. | |||
642 | Follow these steps to locate and download a particular tarball: | 641 | Follow these steps to locate and download a particular tarball: |
643 | 642 | ||
644 | 1. *Access the Index of Releases:* Open a browser and go to | 643 | 1. *Access the Index of Releases:* Open a browser and go to |
645 | ` <&YOCTO_DL_URL;/releases>`__ to access the Index of Releases. The | 644 | :yocto_dl:`Index of Releases <releases>`. The |
646 | list represents released components (e.g. ``bitbake``, ``sato``, and | 645 | list represents released components (e.g. ``bitbake``, ``sato``, and |
647 | so on). | 646 | so on). |
648 | 647 | ||
@@ -670,7 +669,7 @@ Follow these steps to locate and download a particular tarball: | |||
670 | Using the Downloads Page | 669 | Using the Downloads Page |
671 | ------------------------ | 670 | ------------------------ |
672 | 671 | ||
673 | The `Yocto Project Website <&YOCTO_HOME_URL;>`__ uses a "DOWNLOADS" page | 672 | The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page |
674 | from which you can locate and download tarballs of any Yocto Project | 673 | from which you can locate and download tarballs of any Yocto Project |
675 | release. Rather than Git repositories, these files represent snapshot | 674 | release. Rather than Git repositories, these files represent snapshot |
676 | tarballs similar to the tarballs located in the Index of Releases | 675 | tarballs similar to the tarballs located in the Index of Releases |
@@ -684,8 +683,8 @@ Releases <#accessing-index-of-releases>`__" section. | |||
684 | repository. The procedure in this section exists should you desire a | 683 | repository. The procedure in this section exists should you desire a |
685 | tarball snapshot of any given component. | 684 | tarball snapshot of any given component. |
686 | 685 | ||
687 | 1. *Go to the Yocto Project Website:* Open The `Yocto Project | 686 | 1. *Go to the Yocto Project Website:* Open The |
688 | Website <&YOCTO_HOME_URL;>`__ in your browser. | 687 | :yocto_home:`Yocto Project Website <>` in your browser. |
689 | 688 | ||
690 | 2. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the | 689 | 2. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the |
691 | pull-down "SOFTWARE" tab menu near the top of the page. | 690 | pull-down "SOFTWARE" tab menu near the top of the page. |