summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:35 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commit097d0c9f04353866302efebcdd0b497c2b89cabb (patch)
tree305ac5b0776eb37623a9be99a81bee3434a5e4a9 /documentation/dev-manual
parentbd1789261122c25d62b8e8e7f7d5647249e8d8ff (diff)
downloadpoky-097d0c9f04353866302efebcdd0b497c2b89cabb.tar.gz
sphinx: use absolute paths for :doc: references
:doc: references can be made with absolute path instead of relative path. This patch was generated with this command: sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst And a few manual fixup we made for references such as: :doc:"FOOBAR <../xxx>" Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst14
-rw-r--r--documentation/dev-manual/dev-manual-intro.rst6
-rw-r--r--documentation/dev-manual/dev-manual-start.rst14
3 files changed, 17 insertions, 17 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index e22bcd50ec..0a2e6d9df3 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -1319,7 +1319,7 @@ to determine how well the build went.
1319 ``log.do_fetch``, and ``log.do_compile``). 1319 ``log.do_fetch``, and ``log.do_compile``).
1320 1320
1321You can find more information about the build process in 1321You can find more information about the build process in
1322":doc:`../overview-manual/overview-manual-development-environment`" 1322":doc:`/overview-manual/overview-manual-development-environment`"
1323chapter of the Yocto Project Overview and Concepts Manual. 1323chapter of the Yocto Project Overview and Concepts Manual.
1324 1324
1325Fetching Code 1325Fetching Code
@@ -3127,7 +3127,7 @@ Using ``devtool upgrade``
3127 3127
3128As mentioned earlier, an alternative method for upgrading recipes to 3128As mentioned earlier, an alternative method for upgrading recipes to
3129newer versions is to use 3129newer versions is to use
3130:doc:`devtool upgrade <../ref-manual/ref-devtool-reference>`. 3130:doc:`devtool upgrade </ref-manual/ref-devtool-reference>`.
3131You can read about ``devtool upgrade`` in general in the 3131You can read about ``devtool upgrade`` in general in the
3132":ref:`sdk-manual/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" 3132":ref:`sdk-manual/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`"
3133section in the Yocto Project Application Development and the Extensible 3133section in the Yocto Project Application Development and the Extensible
@@ -3644,7 +3644,7 @@ build host running Linux.
3644 3644
3645 - For information on how to build an image using 3645 - For information on how to build an image using
3646 :term:`Toaster`, see the 3646 :term:`Toaster`, see the
3647 :doc:`../toaster-manual/index`. 3647 :doc:`/toaster-manual/index`.
3648 3648
3649 - For information on how to use ``devtool`` to build images, see the 3649 - For information on how to use ``devtool`` to build images, see the
3650 ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`" 3650 ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`"
@@ -3653,7 +3653,7 @@ build host running Linux.
3653 3653
3654 - For a quick example on how to build an image using the 3654 - For a quick example on how to build an image using the
3655 OpenEmbedded build system, see the 3655 OpenEmbedded build system, see the
3656 :doc:`../brief-yoctoprojectqs/index` document. 3656 :doc:`/brief-yoctoprojectqs/index` document.
3657 3657
3658The build process creates an entire Linux distribution from source and 3658The build process creates an entire Linux distribution from source and
3659places it in your :term:`Build Directory` under 3659places it in your :term:`Build Directory` under
@@ -3728,7 +3728,7 @@ The following figure and list overviews the build process:
3728 kernels built by the OpenEmbedded build system are placed in the 3728 kernels built by the OpenEmbedded build system are placed in the
3729 Build Directory in ``tmp/deploy/images``. For information on how to 3729 Build Directory in ``tmp/deploy/images``. For information on how to
3730 run pre-built images such as ``qemux86`` and ``qemuarm``, see the 3730 run pre-built images such as ``qemux86`` and ``qemuarm``, see the
3731 :doc:`../sdk-manual/index` manual. For 3731 :doc:`/sdk-manual/index` manual. For
3732 information about how to install these images, see the documentation 3732 information about how to install these images, see the documentation
3733 for your particular board or machine. 3733 for your particular board or machine.
3734 3734
@@ -7418,7 +7418,7 @@ Creating Node Package Manager (NPM) Packages
7418manager for the JavaScript programming language. The Yocto Project 7418manager for the JavaScript programming language. The Yocto Project
7419supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can 7419supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can
7420use this fetcher in combination with 7420use this fetcher in combination with
7421:doc:`devtool <../ref-manual/ref-devtool-reference>` to create 7421:doc:`devtool </ref-manual/ref-devtool-reference>` to create
7422recipes that produce NPM packages. 7422recipes that produce NPM packages.
7423 7423
7424Two workflows exist that allow you to create NPM packages using 7424Two workflows exist that allow you to create NPM packages using
@@ -7446,7 +7446,7 @@ NPM packages:
7446 is NPM's public registry. 7446 is NPM's public registry.
7447 7447
7448- Be familiar with 7448- Be familiar with
7449 :doc:`devtool <../ref-manual/ref-devtool-reference>`. 7449 :doc:`devtool </ref-manual/ref-devtool-reference>`.
7450 7450
7451- The NPM host tools need the native ``nodejs-npm`` package, which is 7451- The NPM host tools need the native ``nodejs-npm`` package, which is
7452 part of the OpenEmbedded environment. You need to get the package by 7452 part of the OpenEmbedded environment. You need to get the package by
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst
index 94c481b7d8..23c848e870 100644
--- a/documentation/dev-manual/dev-manual-intro.rst
+++ b/documentation/dev-manual/dev-manual-intro.rst
@@ -31,13 +31,13 @@ This manual provides the following:
31This manual does not provide the following: 31This manual does not provide the following:
32 32
33- Redundant Step-by-step Instructions: For example, the 33- Redundant Step-by-step Instructions: For example, the
34 :doc:`../sdk-manual/index` manual contains detailed 34 :doc:`/sdk-manual/index` manual contains detailed
35 instructions on how to install an SDK, which is used to develop 35 instructions on how to install an SDK, which is used to develop
36 applications for target hardware. 36 applications for target hardware.
37 37
38- Reference or Conceptual Material: This type of material resides in an 38- Reference or Conceptual Material: This type of material resides in an
39 appropriate reference manual. For example, system variables are 39 appropriate reference manual. For example, system variables are
40 documented in the :doc:`../ref-manual/index`. 40 documented in the :doc:`/ref-manual/index`.
41 41
42- Detailed Public Information Not Specific to the Yocto Project: For 42- Detailed Public Information Not Specific to the Yocto Project: For
43 example, exhaustive information on how to use the Source Control 43 example, exhaustive information on how to use the Source Control
@@ -52,7 +52,7 @@ supplemental information is recommended for full comprehension. For
52introductory information on the Yocto Project, see the 52introductory information on the Yocto Project, see the
53:yocto_home:`Yocto Project Website <>`. If you want to build an image with no 53:yocto_home:`Yocto Project Website <>`. If you want to build an image with no
54knowledge of Yocto Project as a way of quickly testing it out, see the 54knowledge of Yocto Project as a way of quickly testing it out, see the
55:doc:`../brief-yoctoprojectqs/index` document. 55:doc:`/brief-yoctoprojectqs/index` document.
56 56
57For a comprehensive list of links and other documentation, see the 57For a comprehensive list of links and other documentation, see the
58":ref:`ref-manual/resources:links and related documentation`" 58":ref:`ref-manual/resources:links and related documentation`"
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index 053f09cdcd..d4727a6f6f 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -342,10 +342,10 @@ using a given development path on your native Linux machine. If you are
342going to use BitBake, see the 342going to use BitBake, see the
343":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" 343":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`"
344section. If you are going 344section. If you are going
345to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto 345to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
346Project Application Development and the Extensible Software Development 346Project Application Development and the Extensible Software Development
347Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/index`. If you are going to use 347Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use
348Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" 348Toaster, see the ":doc:`/toaster-manual/toaster-manual-setup-and-use`"
349section in the Toaster User Manual. 349section in the Toaster User Manual.
350 350
351Setting Up to Use CROss PlatformS (CROPS) 351Setting Up to Use CROss PlatformS (CROPS)
@@ -442,10 +442,10 @@ as if you were running on a native Linux machine. If you are going to
442use the Poky container, see the 442use the Poky container, see the
443":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" 443":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`"
444section. If you are going to use the Extensible SDK container, see the 444section. If you are going to use the Extensible SDK container, see the
445":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto 445":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
446Project Application Development and the Extensible Software Development 446Project Application Development and the Extensible Software Development
447Kit (eSDK) manual. If you are going to use the Toaster container, see 447Kit (eSDK) manual. If you are going to use the Toaster container, see
448the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" 448the ":doc:`/toaster-manual/toaster-manual-setup-and-use`"
449section in the Toaster User Manual. 449section in the Toaster User Manual.
450 450
451Setting Up to Use Windows Subsystem For Linux (WSLv2) 451Setting Up to Use Windows Subsystem For Linux (WSLv2)
@@ -557,10 +557,10 @@ your Yocto Project build host:
557 557
558Once you have WSLv2 set up, everything is in place to develop just as if 558Once you have WSLv2 set up, everything is in place to develop just as if
559you were running on a native Linux machine. If you are going to use the 559you were running on a native Linux machine. If you are going to use the
560Extensible SDK container, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto 560Extensible SDK container, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
561Project Application Development and the Extensible Software Development 561Project Application Development and the Extensible Software Development
562Kit (eSDK) manual. If you are going to use the Toaster container, see 562Kit (eSDK) manual. If you are going to use the Toaster container, see
563the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" 563the ":doc:`/toaster-manual/toaster-manual-setup-and-use`"
564section in the Toaster User Manual. 564section in the Toaster User Manual.
565 565
566Locating Yocto Project Source Files 566Locating Yocto Project Source Files