From 097d0c9f04353866302efebcdd0b497c2b89cabb Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 3 Dec 2020 22:38:35 +0100 Subject: 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 (From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-common-tasks.rst | 14 +++++++------- documentation/dev-manual/dev-manual-intro.rst | 6 +++--- documentation/dev-manual/dev-manual-start.rst | 14 +++++++------- 3 files changed, 17 insertions(+), 17 deletions(-) (limited to 'documentation/dev-manual') 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. ``log.do_fetch``, and ``log.do_compile``). You can find more information about the build process in -":doc:`../overview-manual/overview-manual-development-environment`" +":doc:`/overview-manual/overview-manual-development-environment`" chapter of the Yocto Project Overview and Concepts Manual. Fetching Code @@ -3127,7 +3127,7 @@ Using ``devtool upgrade`` As mentioned earlier, an alternative method for upgrading recipes to newer versions is to use -:doc:`devtool upgrade <../ref-manual/ref-devtool-reference>`. +:doc:`devtool upgrade `. You can read about ``devtool upgrade`` in general in the ":ref:`sdk-manual/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" section in the Yocto Project Application Development and the Extensible @@ -3644,7 +3644,7 @@ build host running Linux. - For information on how to build an image using :term:`Toaster`, see the - :doc:`../toaster-manual/index`. + :doc:`/toaster-manual/index`. - For information on how to use ``devtool`` to build images, see the ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`" @@ -3653,7 +3653,7 @@ build host running Linux. - For a quick example on how to build an image using the OpenEmbedded build system, see the - :doc:`../brief-yoctoprojectqs/index` document. + :doc:`/brief-yoctoprojectqs/index` document. The build process creates an entire Linux distribution from source and places it in your :term:`Build Directory` under @@ -3728,7 +3728,7 @@ The following figure and list overviews the build process: kernels built by the OpenEmbedded build system are placed in the Build Directory in ``tmp/deploy/images``. For information on how to run pre-built images such as ``qemux86`` and ``qemuarm``, see the - :doc:`../sdk-manual/index` manual. For + :doc:`/sdk-manual/index` manual. For information about how to install these images, see the documentation for your particular board or machine. @@ -7418,7 +7418,7 @@ Creating Node Package Manager (NPM) Packages manager for the JavaScript programming language. The Yocto Project supports the NPM :ref:`fetcher `. You can use this fetcher in combination with -:doc:`devtool <../ref-manual/ref-devtool-reference>` to create +:doc:`devtool ` to create recipes that produce NPM packages. Two workflows exist that allow you to create NPM packages using @@ -7446,7 +7446,7 @@ NPM packages: is NPM's public registry. - Be familiar with - :doc:`devtool <../ref-manual/ref-devtool-reference>`. + :doc:`devtool `. - The NPM host tools need the native ``nodejs-npm`` package, which is 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: This manual does not provide the following: - Redundant Step-by-step Instructions: For example, the - :doc:`../sdk-manual/index` manual contains detailed + :doc:`/sdk-manual/index` manual contains detailed instructions on how to install an SDK, which is used to develop applications for target hardware. - Reference or Conceptual Material: This type of material resides in an appropriate reference manual. For example, system variables are - documented in the :doc:`../ref-manual/index`. + documented in the :doc:`/ref-manual/index`. - Detailed Public Information Not Specific to the Yocto Project: For example, exhaustive information on how to use the Source Control @@ -52,7 +52,7 @@ supplemental information is recommended for full comprehension. For introductory information on the Yocto Project, see the :yocto_home:`Yocto Project Website <>`. If you want to build an image with no knowledge of Yocto Project as a way of quickly testing it out, see the -:doc:`../brief-yoctoprojectqs/index` document. +:doc:`/brief-yoctoprojectqs/index` document. For a comprehensive list of links and other documentation, see the ":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 going to use BitBake, see the ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" section. If you are going -to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto +to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto Project Application Development and the Extensible Software Development -Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/index`. If you are going to use -Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" +Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use +Toaster, see the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" section in the Toaster User Manual. Setting 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 use the Poky container, see the ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" section. If you are going to use the Extensible SDK container, see the -":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto +":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you are going to use the Toaster container, see -the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" +the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" section in the Toaster User Manual. Setting Up to Use Windows Subsystem For Linux (WSLv2) @@ -557,10 +557,10 @@ your Yocto Project build host: Once you have WSLv2 set up, everything is in place to develop just as if you were running on a native Linux machine. If you are going to use the -Extensible SDK container, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto +Extensible SDK container, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. If you are going to use the Toaster container, see -the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" +the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" section in the Toaster User Manual. Locating Yocto Project Source Files -- cgit v1.2.3-54-g00ecf