diff options
| author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-14 22:48:44 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:35 +0100 |
| commit | 292598164a304a3da3288e6fb8963f13045d1e7f (patch) | |
| tree | efedbbdc16cb2e0978a4d40e6a6294e32b0e496f /documentation/ref-manual/resources.rst | |
| parent | d313d972bf592de77f2af13cb3fc4226247cb1a1 (diff) | |
| download | poky-292598164a304a3da3288e6fb8963f13045d1e7f.tar.gz | |
sphinx: ref-manual links fixes and many other cleanups to import
(From yocto-docs rev: d079e418d5a81610e1f06a7a6ca45dd040c1402e)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/resources.rst')
| -rw-r--r-- | documentation/ref-manual/resources.rst | 48 |
1 files changed, 20 insertions, 28 deletions
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index c5ddcca97f..2b82b79102 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
| @@ -23,8 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes | |||
| 23 | to the project either by creating and sending pull requests, or by | 23 | to the project either by creating and sending pull requests, or by |
| 24 | submitting patches through email. For information on how to do both as | 24 | submitting patches through email. For information on how to do both as |
| 25 | well as information on how to identify the maintainer for each area of | 25 | well as information on how to identify the maintainer for each area of |
| 26 | code, see the "`Submitting a Change to the Yocto | 26 | code, see the ":ref:`how-to-submit-a-change`" section in the |
| 27 | Project <&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change>`__" section in the | ||
| 28 | Yocto Project Development Tasks Manual. | 27 | Yocto Project Development Tasks Manual. |
| 29 | 28 | ||
| 30 | .. _resources-bugtracker: | 29 | .. _resources-bugtracker: |
| @@ -48,8 +47,7 @@ A general procedure and guidelines exist for when you use Bugzilla to | |||
| 48 | submit a bug. For information on how to use Bugzilla to submit a bug | 47 | submit a bug. For information on how to use Bugzilla to submit a bug |
| 49 | against the Yocto Project, see the following: | 48 | against the Yocto Project, see the following: |
| 50 | 49 | ||
| 51 | - The "`Submitting a Defect Against the Yocto | 50 | - The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" |
| 52 | Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" | ||
| 53 | section in the Yocto Project Development Tasks Manual. | 51 | section in the Yocto Project Development Tasks Manual. |
| 54 | 52 | ||
| 55 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` | 53 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` |
| @@ -67,22 +65,22 @@ and announcements. To subscribe to one of the following mailing lists, | |||
| 67 | click on the appropriate URL in the following list and follow the | 65 | click on the appropriate URL in the following list and follow the |
| 68 | instructions: | 66 | instructions: |
| 69 | 67 | ||
| 70 | - ` <&YOCTO_LISTS_URL;/listinfo/yocto>`__ - General Yocto Project | 68 | - https://lists.yoctoproject.org/g/yocto - General Yocto Project |
| 71 | discussion mailing list. | 69 | discussion mailing list. |
| 72 | 70 | ||
| 73 | - ` <&OE_LISTS_URL;/listinfo/openembedded-core>`__ - Discussion mailing | 71 | - https://lists.openembedded.org/g/openembedded-core - Discussion mailing |
| 74 | list about OpenEmbedded-Core (the core metadata). | 72 | list about OpenEmbedded-Core (the core metadata). |
| 75 | 73 | ||
| 76 | - ` <&OE_LISTS_URL;/listinfo/openembedded-devel>`__ - Discussion | 74 | - https://lists.openembedded.org/g/openembedded-devel - Discussion |
| 77 | mailing list about OpenEmbedded. | 75 | mailing list about OpenEmbedded. |
| 78 | 76 | ||
| 79 | - ` <&OE_LISTS_URL;/listinfo/bitbake-devel>`__ - Discussion mailing | 77 | - https://lists.openembedded.org/g/bitbake-devel - Discussion mailing |
| 80 | list about the :term:`BitBake` build tool. | 78 | list about the :term:`BitBake` build tool. |
| 81 | 79 | ||
| 82 | - ` <&YOCTO_LISTS_URL;/listinfo/poky>`__ - Discussion mailing list | 80 | - https://lists.yoctoproject.org/g/poky - Discussion mailing list |
| 83 | about `Poky <#poky>`__. | 81 | about `Poky <#poky>`__. |
| 84 | 82 | ||
| 85 | - ` <&YOCTO_LISTS_URL;/listinfo/yocto-announce>`__ - Mailing list to | 83 | - https://lists.yoctoproject.org/g/yocto-announce - Mailing list to |
| 86 | receive official Yocto Project release and milestone announcements. | 84 | receive official Yocto Project release and milestone announcements. |
| 87 | 85 | ||
| 88 | For more Yocto Project-related mailing lists, see the | 86 | For more Yocto Project-related mailing lists, see the |
| @@ -115,7 +113,7 @@ Here is a list of resources you might find helpful: | |||
| 115 | planning, release engineering, QA & automation, a reference site map, | 113 | planning, release engineering, QA & automation, a reference site map, |
| 116 | and other resources related to the Yocto Project. | 114 | and other resources related to the Yocto Project. |
| 117 | 115 | ||
| 118 | - `OpenEmbedded <&OE_HOME_URL;>`__\ *:* The build system used by the | 116 | - `OpenEmbedded <http://www.openembedded.org/>`__\ *:* The build system used by the |
| 119 | Yocto Project. This project is the upstream, generic, embedded | 117 | Yocto Project. This project is the upstream, generic, embedded |
| 120 | distribution from which the Yocto Project derives its build system | 118 | distribution from which the Yocto Project derives its build system |
| 121 | (Poky) and to which it contributes. | 119 | (Poky) and to which it contributes. |
| @@ -127,53 +125,47 @@ Here is a list of resources you might find helpful: | |||
| 127 | guide to the BitBake tool. If you want information on BitBake, see | 125 | guide to the BitBake tool. If you want information on BitBake, see |
| 128 | this manual. | 126 | this manual. |
| 129 | 127 | ||
| 130 | - `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__\ *:* This | 128 | - :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` *:* This |
| 131 | short document lets you experience building an image using the Yocto | 129 | short document lets you experience building an image using the Yocto |
| 132 | Project without having to understand any concepts or details. | 130 | Project without having to understand any concepts or details. |
| 133 | 131 | ||
| 134 | - `Yocto Project Overview and Concepts | 132 | - :doc:`../overview-manual/overview-manual` *:* This manual provides overview |
| 135 | Manual <&YOCTO_DOCS_OM_URL;>`__\ *:* This manual provides overview | ||
| 136 | and conceptual information about the Yocto Project. | 133 | and conceptual information about the Yocto Project. |
| 137 | 134 | ||
| 138 | - `Yocto Project Development Tasks | 135 | - :doc:`../dev-manual/dev-manual` *:* This manual is a "how-to" guide |
| 139 | Manual <&YOCTO_DOCS_DEV_URL;>`__\ *:* This manual is a "how-to" guide | ||
| 140 | that presents procedures useful to both application and system | 136 | that presents procedures useful to both application and system |
| 141 | developers who use the Yocto Project. | 137 | developers who use the Yocto Project. |
| 142 | 138 | ||
| 143 | - `Yocto Project Application Development and the Extensible Software | 139 | - :doc:`../sdk-manual/sdk-manual` *manual :* This |
| 144 | Development Kit (eSDK) <&YOCTO_DOCS_SDK_URL;>`__\ *manual:* This | ||
| 145 | guide provides information that lets you get going with the standard | 140 | guide provides information that lets you get going with the standard |
| 146 | or extensible SDK. An SDK, with its cross-development toolchains, | 141 | or extensible SDK. An SDK, with its cross-development toolchains, |
| 147 | allows you to develop projects inside or outside of the Yocto Project | 142 | allows you to develop projects inside or outside of the Yocto Project |
| 148 | environment. | 143 | environment. |
| 149 | 144 | ||
| 150 | - `Yocto Project Board Support Package (BSP) Developer's | 145 | - :doc:`../bsp-guide/bsp` *:* This guide defines the structure |
| 151 | Guide <&YOCTO_DOCS_BSP_URL;>`__\ *:* This guide defines the structure | ||
| 152 | for BSP components. Having a commonly understood structure encourages | 146 | for BSP components. Having a commonly understood structure encourages |
| 153 | standardization. | 147 | standardization. |
| 154 | 148 | ||
| 155 | - `Yocto Project Linux Kernel Development | 149 | - :doc:`../kernel-dev/kernel-dev` *:* This manual describes |
| 156 | Manual <&YOCTO_DOCS_KERNEL_DEV_URL;>`__\ *:* This manual describes | ||
| 157 | how to work with Linux Yocto kernels as well as provides a bit of | 150 | how to work with Linux Yocto kernels as well as provides a bit of |
| 158 | conceptual information on the construction of the Yocto Linux kernel | 151 | conceptual information on the construction of the Yocto Linux kernel |
| 159 | tree. | 152 | tree. |
| 160 | 153 | ||
| 161 | - `Yocto Project Reference Manual <&YOCTO_DOCS_REF_URL;>`__\ *:* This | 154 | - :doc:`../ref-manual/ref-manual` *:* This |
| 162 | manual provides reference material such as variable, task, and class | 155 | manual provides reference material such as variable, task, and class |
| 163 | descriptions. | 156 | descriptions. |
| 164 | 157 | ||
| 165 | - `Yocto Project Mega-Manual <&YOCTO_DOCS_MM_URL;>`__\ *:* This manual | 158 | - `Yocto Project Mega-Manual <https://docs.yoctoproject.org/singleindex.html>`__\ *:* This manual |
| 166 | is simply a single HTML file comprised of the bulk of the Yocto | 159 | is simply a single HTML file comprised of the bulk of the Yocto |
| 167 | Project manuals. The Mega-Manual primarily exists as a vehicle by | 160 | Project manuals. The Mega-Manual primarily exists as a vehicle by |
| 168 | which you can easily search for phrases and terms used in the Yocto | 161 | which you can easily search for phrases and terms used in the Yocto |
| 169 | Project documentation set. | 162 | Project documentation set. |
| 170 | 163 | ||
| 171 | - `Yocto Project Profiling and Tracing | 164 | - :doc:`../profile-manual/profile-manual` *:* This manual presents a set of |
| 172 | Manual <&YOCTO_DOCS_PROF_URL;>`__\ *:* This manual presents a set of | ||
| 173 | common and generally useful tracing and profiling schemes along with | 165 | common and generally useful tracing and profiling schemes along with |
| 174 | their applications (as appropriate) to each tool. | 166 | their applications (as appropriate) to each tool. |
| 175 | 167 | ||
| 176 | - `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__\ *:* This manual | 168 | - :doc:`../toaster-manual/toaster-manual` *:* This manual |
| 177 | introduces and describes how to set up and use Toaster. Toaster is an | 169 | introduces and describes how to set up and use Toaster. Toaster is an |
| 178 | Application Programming Interface (API) and web-based interface to | 170 | Application Programming Interface (API) and web-based interface to |
| 179 | the :term:`OpenEmbedded Build System`, which uses | 171 | the :term:`OpenEmbedded Build System`, which uses |
| @@ -188,7 +180,7 @@ Here is a list of resources you might find helpful: | |||
| 188 | the Yocto Project website and click on the "RELEASE INFORMATION" link | 180 | the Yocto Project website and click on the "RELEASE INFORMATION" link |
| 189 | for the appropriate release. | 181 | for the appropriate release. |
| 190 | 182 | ||
| 191 | - `Bugzilla <&YOCTO_BUGZILLA_URL;>`__\ *:* The bug tracking application | 183 | - `Bugzilla <https://bugzilla.yoctoproject.org>`__\ *:* The bug tracking application |
| 192 | the Yocto Project uses. If you find problems with the Yocto Project, | 184 | the Yocto Project uses. If you find problems with the Yocto Project, |
| 193 | you should report them using this application. | 185 | you should report them using this application. |
| 194 | 186 | ||
