diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:34 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | bd1789261122c25d62b8e8e7f7d5647249e8d8ff (patch) | |
tree | 5b831c41d669f37ce42dac9f25a57052fd61119a /documentation/what-i-wish-id-known.rst | |
parent | d1f0448ca9233fe1a4dc46e6bf86762b31ff34ef (diff) | |
download | poky-bd1789261122c25d62b8e8e7f7d5647249e8d8ff.tar.gz |
sphinx: rename top level document in each manual
It is more common to call the top level document index.rst. This is
what this patch is doing, along with all required references fixup.
(From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/what-i-wish-id-known.rst')
-rw-r--r-- | documentation/what-i-wish-id-known.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index afc1263829..3f9fdea5fa 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
@@ -49,7 +49,7 @@ contact us with other suggestions. | |||
49 | their silicon. These layers have names such as "meta-intel" or "meta-ti". Try | 49 | their silicon. These layers have names such as "meta-intel" or "meta-ti". Try |
50 | not to build layers from scratch. If you do have custom silicon, use one of | 50 | not to build layers from scratch. If you do have custom silicon, use one of |
51 | these layers as a guide or template and familiarize yourself with the | 51 | these layers as a guide or template and familiarize yourself with the |
52 | :doc:`bsp-guide/bsp-guide`. | 52 | :doc:`bsp-guide/index`. |
53 | 53 | ||
54 | #. **Do not put everything into one layer:** | 54 | #. **Do not put everything into one layer:** |
55 | Use different layers to logically separate information in your build. As an | 55 | Use different layers to logically separate information in your build. As an |
@@ -126,7 +126,7 @@ contact us with other suggestions. | |||
126 | You can build and run a specific task for a specific package (including | 126 | You can build and run a specific task for a specific package (including |
127 | devshell) or even a single recipe. When developers first start using the | 127 | devshell) or even a single recipe. When developers first start using the |
128 | Yocto Project, the instructions found in the | 128 | Yocto Project, the instructions found in the |
129 | :doc:`brief-yoctoprojectqs/brief-yoctoprojectqs` show how to create an image | 129 | :doc:`brief-yoctoprojectqs/index` show how to create an image |
130 | and then run or flash that image. However, you can actually build just a | 130 | and then run or flash that image. However, you can actually build just a |
131 | single recipe. Thus, if some dependency or recipe isn't working, you can just | 131 | single recipe. Thus, if some dependency or recipe isn't working, you can just |
132 | say "bitbake foo" where "foo" is the name for a specific recipe. As you | 132 | say "bitbake foo" where "foo" is the name for a specific recipe. As you |
@@ -190,7 +190,7 @@ contact us with other suggestions. | |||
190 | contains procedural information grouped to help you get set up, work with | 190 | contains procedural information grouped to help you get set up, work with |
191 | layers, customize images, write new recipes, work with libraries, and use | 191 | layers, customize images, write new recipes, work with libraries, and use |
192 | QEMU. The information is task-based and spans the breadth of the Yocto | 192 | QEMU. The information is task-based and spans the breadth of the Yocto |
193 | Project. See the :doc:`../dev-manual/dev-manual`. | 193 | Project. See the :doc:`../dev-manual/index`. |
194 | 194 | ||
195 | * **Look Through the Yocto Project Application Development and the Extensible | 195 | * **Look Through the Yocto Project Application Development and the Extensible |
196 | Software Development Kit (eSDK) manual**: This manual describes how to use | 196 | Software Development Kit (eSDK) manual**: This manual describes how to use |
@@ -201,17 +201,17 @@ contact us with other suggestions. | |||
201 | for more information. | 201 | for more information. |
202 | 202 | ||
203 | * **Learn About Kernel Development**: If you want to see how to work with the | 203 | * **Learn About Kernel Development**: If you want to see how to work with the |
204 | kernel and understand Yocto Linux kernels, see the :doc:`../kernel-dev/kernel-dev`. | 204 | kernel and understand Yocto Linux kernels, see the :doc:`../kernel-dev/index`. |
205 | This manual provides information on how to patch the kernel, modify kernel | 205 | This manual provides information on how to patch the kernel, modify kernel |
206 | recipes, and configure the kernel. | 206 | recipes, and configure the kernel. |
207 | 207 | ||
208 | * **Learn About Board Support Packages (BSPs)**: If you want to learn about | 208 | * **Learn About Board Support Packages (BSPs)**: If you want to learn about |
209 | BSPs, see the :doc:`../bsp-guide/bsp-guide`. This manual also provides an | 209 | BSPs, see the :doc:`../bsp-guide/index`. This manual also provides an |
210 | example BSP creation workflow. See the :doc:`../bsp-guide/bsp` section. | 210 | example BSP creation workflow. See the :doc:`../bsp-guide/bsp` section. |
211 | 211 | ||
212 | * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's | 212 | * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's |
213 | OpenEmbedded build system. If you are interested in using this type of | 213 | OpenEmbedded build system. If you are interested in using this type of |
214 | interface to create images, see the :doc:`../toaster-manual/toaster-manual`. | 214 | interface to create images, see the :doc:`../toaster-manual/index`. |
215 | 215 | ||
216 | * **Have Available the Yocto Project Reference Manual**: Unlike the rest of | 216 | * **Have Available the Yocto Project Reference Manual**: Unlike the rest of |
217 | the Yocto Project manual set, this manual is comprised of material suited | 217 | the Yocto Project manual set, this manual is comprised of material suited |
@@ -219,7 +219,7 @@ contact us with other suggestions. | |||
219 | look at how the pieces of the Yocto Project development environment work | 219 | look at how the pieces of the Yocto Project development environment work |
220 | together, information on various technical details, guidance on migrating | 220 | together, information on various technical details, guidance on migrating |
221 | to a newer Yocto Project release, reference material on the directory | 221 | to a newer Yocto Project release, reference material on the directory |
222 | structure, classes, and tasks. The :doc:`../ref-manual/ref-manual` also | 222 | structure, classes, and tasks. The :doc:`../ref-manual/index` also |
223 | contains a fairly comprehensive glossary of variables used within the Yocto | 223 | contains a fairly comprehensive glossary of variables used within the Yocto |
224 | Project. | 224 | Project. |
225 | 225 | ||