diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-02-23 16:08:00 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-02-24 15:43:25 +0000 |
commit | a354dc9c62df3e028509ea2b73e76a5d0ae08239 (patch) | |
tree | 79a79942c7ce894bf592b5c321fd6a117aeab454 /documentation/dev-manual | |
parent | f279a84ee70bf1c1746757abc11aa5debf19b311 (diff) | |
download | poky-a354dc9c62df3e028509ea2b73e76a5d0ae08239.tar.gz |
dev-manual: new-recipe.rst: add references to subsections in Examples section
Making it possible to jump right away to the desired example
Rename a section title to make it more suitable for a link title.
Using short references (`Section Name`_) instead of
:ref:`dev-manual/new-recipe:Section Name`) as we are in the same
document.
(From yocto-docs rev: 4058998dbeba4262ccced8999be338c04c324b48)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/new-recipe.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index a73920f8a4..1ed217be7f 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst | |||
@@ -361,7 +361,7 @@ and searches specific directories in a certain order: | |||
361 | ``files``. The directories are assumed to be subdirectories of the | 361 | ``files``. The directories are assumed to be subdirectories of the |
362 | directory in which the recipe or append file resides. For another | 362 | directory in which the recipe or append file resides. For another |
363 | example that specifies these types of files, see the | 363 | example that specifies these types of files, see the |
364 | ":ref:`dev-manual/new-recipe:building a single .c file package (hello world!)`" section. | 364 | "`building a single .c file package`_" section. |
365 | 365 | ||
366 | The previous example also specifies a patch file. Patch files are files | 366 | The previous example also specifies a patch file. Patch files are files |
367 | whose names usually end in ``.patch`` or ``.diff`` but can end with | 367 | whose names usually end in ``.patch`` or ``.diff`` but can end with |
@@ -1167,20 +1167,20 @@ Examples | |||
1167 | To help summarize how to write a recipe, this section provides some | 1167 | To help summarize how to write a recipe, this section provides some |
1168 | recipe examples given various scenarios: | 1168 | recipe examples given various scenarios: |
1169 | 1169 | ||
1170 | - Building packages from a single local file | 1170 | - `Building a single .c file package`_ |
1171 | 1171 | ||
1172 | - Building a Makefile-based package | 1172 | - `Building a Makefile-based package`_ |
1173 | 1173 | ||
1174 | - Building an Autotooled package | 1174 | - `Building an Autotooled package`_ |
1175 | 1175 | ||
1176 | - Building a Meson package | 1176 | - `Building a Meson package`_ |
1177 | 1177 | ||
1178 | - Splitting an application into multiple packages | 1178 | - `Splitting an application into multiple packages`_ |
1179 | 1179 | ||
1180 | - Adding binaries to an image | 1180 | - `Packaging externally produced binaries`_ |
1181 | 1181 | ||
1182 | Building a Single .c File Package (Hello World!) | 1182 | Building a Single .c File Package |
1183 | ------------------------------------------------ | 1183 | --------------------------------- |
1184 | 1184 | ||
1185 | Building an application from a single file that is stored locally (e.g. under | 1185 | Building an application from a single file that is stored locally (e.g. under |
1186 | ``files``) requires a recipe that has the file listed in the :term:`SRC_URI` | 1186 | ``files``) requires a recipe that has the file listed in the :term:`SRC_URI` |