diff options
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/faq.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/index.rst (renamed from documentation/ref-manual/ref-manual.rst) | 0 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.1.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-features.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/ref-structure.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-system-requirements.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/ref-terms.rst | 12 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/resources.rst | 16 |
9 files changed, 22 insertions, 26 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 3ffc1f2c41..747561e061 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
@@ -47,7 +47,7 @@ Support Package (BSP) layer for it. For more information on how to | |||
47 | create a BSP layer, see the | 47 | create a BSP layer, see the |
48 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 48 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" |
49 | section in the Yocto Project Development Tasks Manual and the | 49 | section in the Yocto Project Development Tasks Manual and the |
50 | :doc:`../bsp-guide/bsp-guide`. | 50 | :doc:`../bsp-guide/index`. |
51 | 51 | ||
52 | Usually, if the board is not completely exotic, adding support in the | 52 | Usually, if the board is not completely exotic, adding support in the |
53 | Yocto Project is fairly straightforward. | 53 | Yocto Project is fairly straightforward. |
diff --git a/documentation/ref-manual/ref-manual.rst b/documentation/ref-manual/index.rst index 033f4ba28c..033f4ba28c 100644 --- a/documentation/ref-manual/ref-manual.rst +++ b/documentation/ref-manual/index.rst | |||
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index 0220221e01..8ea1aa7f0a 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst | |||
@@ -234,7 +234,7 @@ functionality almost completely overlapped with the :ref:`standard | |||
234 | SDK <sdk-manual/sdk-using:using the standard sdk>` and the | 234 | SDK <sdk-manual/sdk-using:using the standard sdk>` and the |
235 | :ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For | 235 | :ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For |
236 | information on these SDKs and how to build and use them, see the | 236 | information on these SDKs and how to build and use them, see the |
237 | :doc:`../sdk-manual/sdk-manual` manual. | 237 | :doc:`../sdk-manual/index` manual. |
238 | 238 | ||
239 | .. note:: | 239 | .. note:: |
240 | 240 | ||
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst index a16460e91c..c9223e4131 100644 --- a/documentation/ref-manual/ref-features.rst +++ b/documentation/ref-manual/ref-features.rst | |||
@@ -261,7 +261,7 @@ these valid features is as follows: | |||
261 | 261 | ||
262 | - *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and | 262 | - *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and |
263 | ``LTTng``. For general information on user-space tools, see the | 263 | ``LTTng``. For general information on user-space tools, see the |
264 | :doc:`../sdk-manual/sdk-manual` manual. | 264 | :doc:`../sdk-manual/index` manual. |
265 | 265 | ||
266 | - *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. | 266 | - *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. |
267 | 267 | ||
@@ -275,7 +275,7 @@ these valid features is as follows: | |||
275 | ``gdb``. For information on GDB, see the | 275 | ``gdb``. For information on GDB, see the |
276 | ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section | 276 | ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section |
277 | in the Yocto Project Development Tasks Manual. For information on | 277 | in the Yocto Project Development Tasks Manual. For information on |
278 | tracing and profiling, see the :doc:`../profile-manual/profile-manual`. | 278 | tracing and profiling, see the :doc:`../profile-manual/index`. |
279 | 279 | ||
280 | - *tools-sdk:* Installs a full SDK that runs on the device. | 280 | - *tools-sdk:* Installs a full SDK that runs on the device. |
281 | 281 | ||
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst index 5d17f0e5c4..a172a0b71c 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/ref-structure.rst | |||
@@ -104,7 +104,7 @@ metadata to define the Poky reference distribution. | |||
104 | 104 | ||
105 | This directory contains the Yocto Project reference hardware Board | 105 | This directory contains the Yocto Project reference hardware Board |
106 | Support Packages (BSPs). For more information on BSPs, see the | 106 | Support Packages (BSPs). For more information on BSPs, see the |
107 | :doc:`../bsp-guide/bsp-guide`. | 107 | :doc:`../bsp-guide/index`. |
108 | 108 | ||
109 | .. _structure-meta-selftest: | 109 | .. _structure-meta-selftest: |
110 | 110 | ||
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index af8663a5b2..937cd0c707 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst | |||
@@ -20,9 +20,9 @@ chapter in the Yocto Project Overview and Concepts Manual. | |||
20 | 20 | ||
21 | If you want to use the Yocto Project to quickly build an image without | 21 | If you want to use the Yocto Project to quickly build an image without |
22 | having to understand concepts, work through the | 22 | having to understand concepts, work through the |
23 | :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. You can find "how-to" | 23 | :doc:`../brief-yoctoprojectqs/index` document. You can find "how-to" |
24 | information in the :doc:`../dev-manual/dev-manual`. You can find Yocto Project overview | 24 | information in the :doc:`../dev-manual/index`. You can find Yocto Project overview |
25 | and conceptual information in the :doc:`../overview-manual/overview-manual`. | 25 | and conceptual information in the :doc:`../overview-manual/index`. |
26 | 26 | ||
27 | .. note:: | 27 | .. note:: |
28 | 28 | ||
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index f59aaf2788..3c12a2470c 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst | |||
@@ -58,8 +58,7 @@ universal, the list includes them just in case: | |||
58 | :term:`Board Support Package (BSP)` | 58 | :term:`Board Support Package (BSP)` |
59 | A group of drivers, definitions, and other components that provide support | 59 | A group of drivers, definitions, and other components that provide support |
60 | for a specific hardware configuration. For more information on BSPs, see | 60 | for a specific hardware configuration. For more information on BSPs, see |
61 | the :ref:`bsp-guide/bsp-guide:Yocto Project Board Support Package | 61 | the :doc:`/bsp-guide/index`. |
62 | Developer's Guide`. | ||
63 | 62 | ||
64 | :term:`Build Directory` | 63 | :term:`Build Directory` |
65 | This term refers to the area used by the OpenEmbedded build system for | 64 | This term refers to the area used by the OpenEmbedded build system for |
@@ -164,17 +163,14 @@ universal, the list includes them just in case: | |||
164 | ":ref:`overview-manual/overview-manual-concepts:Cross-Development | 163 | ":ref:`overview-manual/overview-manual-concepts:Cross-Development |
165 | Toolchain Generation`" section in the Yocto Project Overview and Concepts | 164 | Toolchain Generation`" section in the Yocto Project Overview and Concepts |
166 | Manual. You can also find more information on using the relocatable | 165 | Manual. You can also find more information on using the relocatable |
167 | toolchain in the :ref:`sdk-manual/sdk-manual:Yocto Project Application | 166 | toolchain in the :doc:`/sdk-manual/index` manual. |
168 | Development and the Extensible Software Development Kit (eSDK)` manual. | ||
169 | 167 | ||
170 | :term:`Extensible Software Development Kit (eSDK)` | 168 | :term:`Extensible Software Development Kit (eSDK)` |
171 | A custom SDK for application developers. This eSDK allows developers to | 169 | A custom SDK for application developers. This eSDK allows developers to |
172 | incorporate their library and programming changes back into the image to | 170 | incorporate their library and programming changes back into the image to |
173 | make their code available to other application developers. | 171 | make their code available to other application developers. |
174 | 172 | ||
175 | For information on the eSDK, see the :ref:`sdk-manual/sdk-manual:Yocto | 173 | For information on the eSDK, see the :doc:`/sdk-manual/index` manual. |
176 | Project Application Development and the Extensible Software Development | ||
177 | Kit (eSDK)` manual. | ||
178 | 174 | ||
179 | :term:`Image` | 175 | :term:`Image` |
180 | An image is an artifact of the BitBake build process given a collection of | 176 | An image is an artifact of the BitBake build process given a collection of |
@@ -384,7 +380,7 @@ universal, the list includes them just in case: | |||
384 | The interface enables you to | 380 | The interface enables you to |
385 | configure and run your builds. Information about builds is collected | 381 | configure and run your builds. Information about builds is collected |
386 | and stored in a database. For information on Toaster, see the | 382 | and stored in a database. For information on Toaster, see the |
387 | :doc:`../toaster-manual/toaster-manual`. | 383 | :doc:`../toaster-manual/index`. |
388 | 384 | ||
389 | :term:`Upstream` | 385 | :term:`Upstream` |
390 | A reference to source code or repositories that are not | 386 | A reference to source code or repositories that are not |
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index f8cd5416d9..5a52833e84 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -8154,7 +8154,7 @@ system and gives an overview of their function and contents. | |||
8154 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" | 8154 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" |
8155 | section in the Yocto Project Overview and Concepts Manual. For | 8155 | section in the Yocto Project Overview and Concepts Manual. For |
8156 | information on setting up a cross-development environment, see the | 8156 | information on setting up a cross-development environment, see the |
8157 | :doc:`../sdk-manual/sdk-manual` manual. | 8157 | :doc:`../sdk-manual/index` manual. |
8158 | 8158 | ||
8159 | :term:`TOOLCHAIN_OUTPUTNAME` | 8159 | :term:`TOOLCHAIN_OUTPUTNAME` |
8160 | This variable defines the name used for the toolchain output. The | 8160 | This variable defines the name used for the toolchain output. The |
@@ -8184,7 +8184,7 @@ system and gives an overview of their function and contents. | |||
8184 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" | 8184 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" |
8185 | section in the Yocto Project Overview and Concepts Manual. For | 8185 | section in the Yocto Project Overview and Concepts Manual. For |
8186 | information on setting up a cross-development environment, see the | 8186 | information on setting up a cross-development environment, see the |
8187 | :doc:`../sdk-manual/sdk-manual` manual. | 8187 | :doc:`../sdk-manual/index` manual. |
8188 | 8188 | ||
8189 | :term:`TOPDIR` | 8189 | :term:`TOPDIR` |
8190 | The top-level :term:`Build Directory`. BitBake | 8190 | The top-level :term:`Build Directory`. BitBake |
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 70ba8e7be5..e41ce95cf0 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -125,18 +125,18 @@ Here is a list of resources you might find helpful: | |||
125 | 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 |
126 | this manual. | 126 | this manual. |
127 | 127 | ||
128 | - :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` *:* This | 128 | - :doc:`../brief-yoctoprojectqs/index` *:* This |
129 | short document lets you experience building an image using the Yocto | 129 | short document lets you experience building an image using the Yocto |
130 | Project without having to understand any concepts or details. | 130 | Project without having to understand any concepts or details. |
131 | 131 | ||
132 | - :doc:`../overview-manual/overview-manual` *:* This manual provides overview | 132 | - :doc:`../overview-manual/index` *:* This manual provides overview |
133 | and conceptual information about the Yocto Project. | 133 | and conceptual information about the Yocto Project. |
134 | 134 | ||
135 | - :doc:`../dev-manual/dev-manual` *:* This manual is a "how-to" guide | 135 | - :doc:`../dev-manual/index` *:* This manual is a "how-to" guide |
136 | that presents procedures useful to both application and system | 136 | that presents procedures useful to both application and system |
137 | developers who use the Yocto Project. | 137 | developers who use the Yocto Project. |
138 | 138 | ||
139 | - :doc:`../sdk-manual/sdk-manual` *manual :* This | 139 | - :doc:`../sdk-manual/index` *manual :* This |
140 | guide provides information that lets you get going with the standard | 140 | guide provides information that lets you get going with the standard |
141 | or extensible SDK. An SDK, with its cross-development toolchains, | 141 | or extensible SDK. An SDK, with its cross-development toolchains, |
142 | 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 |
@@ -146,12 +146,12 @@ Here is a list of resources you might find helpful: | |||
146 | for BSP components. Having a commonly understood structure encourages | 146 | for BSP components. Having a commonly understood structure encourages |
147 | standardization. | 147 | standardization. |
148 | 148 | ||
149 | - :doc:`../kernel-dev/kernel-dev` *:* This manual describes | 149 | - :doc:`../kernel-dev/index` *:* This manual describes |
150 | 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 |
151 | conceptual information on the construction of the Yocto Linux kernel | 151 | conceptual information on the construction of the Yocto Linux kernel |
152 | tree. | 152 | tree. |
153 | 153 | ||
154 | - :doc:`../ref-manual/ref-manual` *:* This | 154 | - :doc:`../ref-manual/index` *:* This |
155 | manual provides reference material such as variable, task, and class | 155 | manual provides reference material such as variable, task, and class |
156 | descriptions. | 156 | descriptions. |
157 | 157 | ||
@@ -161,11 +161,11 @@ Here is a list of resources you might find helpful: | |||
161 | 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 |
162 | Project documentation set. | 162 | Project documentation set. |
163 | 163 | ||
164 | - :doc:`../profile-manual/profile-manual` *:* This manual presents a set of | 164 | - :doc:`../profile-manual/index` *:* This manual presents a set of |
165 | common and generally useful tracing and profiling schemes along with | 165 | common and generally useful tracing and profiling schemes along with |
166 | their applications (as appropriate) to each tool. | 166 | their applications (as appropriate) to each tool. |
167 | 167 | ||
168 | - :doc:`../toaster-manual/toaster-manual` *:* This manual | 168 | - :doc:`../toaster-manual/index` *:* This manual |
169 | 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 |
170 | Application Programming Interface (API) and web-based interface to | 170 | Application Programming Interface (API) and web-based interface to |
171 | the :term:`OpenEmbedded Build System`, which uses | 171 | the :term:`OpenEmbedded Build System`, which uses |