diff mbox series

[2/2] dev-manual: new-recipe.rst: add references to subsections in Examples section

Message ID 20230223153729.2492175-2-michael.opdenacker@bootlin.com
State New
Headers show
Series [1/2] dev-manual: new-recipe.rst: add Meson example recipe | expand

Commit Message

Michael Opdenacker Feb. 23, 2023, 3:37 p.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

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.

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/new-recipe.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
diff mbox series

Patch

diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index 9f00ac198f..d8cedbf7a4 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:
 ``files``. The directories are assumed to be subdirectories of the
 directory in which the recipe or append file resides. For another
 example that specifies these types of files, see the
-":ref:`dev-manual/new-recipe:building a single .c file package (hello world!)`" section.
+"`building a single .c file package`_" section.
 
 The previous example also specifies a patch file. Patch files are files
 whose names usually end in ``.patch`` or ``.diff`` but can end with
@@ -1167,20 +1167,20 @@  Examples
 To help summarize how to write a recipe, this section provides some
 recipe examples given various scenarios:
 
--  Building packages from a single local file
+-  `Building a single .c file package`_
 
--  Building a Makefile-based package
+-  `Building a Makefile-based package`_
 
--  Building an Autotooled package
+-  `Building an Autotooled package`_
 
--  Building a Meson package
+-  `Building a Meson package`_
 
--  Splitting an application into multiple packages
+-  `Splitting an application into multiple packages`_
 
--  Adding binaries to an image
+-  `Packaging externally produced binaries`_
 
-Building a Single .c File Package (Hello World!)
-------------------------------------------------
+Building a Single .c File Package
+---------------------------------
 
 Building an application from a single file that is stored locally (e.g. under
 ``files``) requires a recipe that has the file listed in the :term:`SRC_URI`