sdk-manual: fix broken references
PATCH 1/1 sdk-manual: fix broken references
Detected by running:
git grep "^[\ ]*\" section" | grep -v "\`"
--- .../sdk-manual/appendix-customizing.rst | 12 ++++++------ documentation/sdk-manual/extensible.rst | 17 ++++++++--------- documentation/sdk-manual/working-projects.rst | 5 ++--- 3 files changed, 16 insertions(+), 18 deletions(-)
documentation/sdk-manual/appendix-customizing.rst +6 -6
@@ -74,9 +74,9 @@ adjustments: is set using the "?=" operator. Consequently, you will need to either define the entire list by using the "=" operator, or you will need to append a value using either "_append" or the "+=" - operator. You can learn more about these operators in the " - Basic Syntax - " section of the BitBake User Manual. + operator. You can learn more about these operators in the + ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" + section of the BitBake User Manual. .
@@ -350,9 +350,9 @@ in most cases. If you set SDK_EXT_TYPE to "minimal", then providing a shared state mirror is mandatory so - that items can be installed as needed. See the " - Providing Additional Installable Extensible SDK Content - " section for more information. + that items can be installed as needed. See the + :ref:`sdk-manual/appendix-customizing:providing additional installable extensible sdk content` + section for more information. You can explicitly control whether or not to include the toolchain when you build an SDK by setting the
documentation/sdk-manual/extensible.rst +8 -9
@@ -15,9 +15,8 @@ hardware, and ease integration into the rest of the .. note:: For a side-by-side comparison of main features supported for an - extensible SDK as compared to a standard SDK, see the " - Introduction - " section. + extensible SDK as compared to a standard SDK, see the + :ref:`sdk-manual/intro:introduction` section. In addition to the functionality available through ``devtool``, you can alternatively make use of the toolchain directly, for example from
@@ -89,9 +88,9 @@ the SDK for ``core-image-sato`` and using the current &DISTRO; snapshot:: .. note:: As an alternative to downloading an SDK, you can build the SDK - installer. For information on building the installer, see the " - Building an SDK Installer - " section. + installer. For information on building the installer, see the + :ref:`sdk-manual/appendix-obtain:building an sdk installer` + section. The SDK and toolchains are self-contained and by default are installed into the ``poky_sdk`` folder in your home directory. You can choose to
@@ -606,9 +605,9 @@ counterparts. Several methods exist by which you can upgrade recipes - devtool upgrade happens to be one. You can read about all the methods by which you - can upgrade recipes in the " - Upgrading Recipes - " section of the Yocto Project Development Tasks Manual. + can upgrade recipes in the + :ref:`dev-manual/common-tasks:upgrading recipes` section + of the Yocto Project Development Tasks Manual. The ``devtool upgrade`` command is flexible enough to allow you to specify source code revision and versioning schemes, extract code into
documentation/sdk-manual/working-projects.rst +2 -3
@@ -135,9 +135,8 @@ project: To learn about environment variables established when you run the cross-toolchain environment setup script and how they are used or - overridden when the Makefile, see the " - Makefile-Based Projects - " section. + overridden when the Makefile, see the + :ref:`sdk-manual/working-projects:makefile-based projects` section. This next command is a simple way to verify the installation of your project. Running the command prints the architecture on which the
Signature · 1 line
2.25.1
Hi Michael,
Quoted 17 lines · Michael Opdenacker
Detected by running:
git grep "^[\ ]*\" section" | grep -v "\`"Signed-off-by Michael Opdenacker <[email protected]>--- .../sdk-manual/appendix-customizing.rst | 12 ++++++------ documentation/sdk-manual/extensible.rst | 17 ++++++++--------- documentation/sdk-manual/working-projects.rst | 5 ++--- 3 files changed, 16 insertions(+), 18 deletions(-)documentation/sdk-manual/appendix-customizing.rst +0
-0@@ -74,9 +74,9 @@ adjustments: is set using the "?=" operator. Consequently, you will need to either define the entire list by using the "=" operator, or you
documentation/sdk-manual/appendix-customizing.rst adjustments: · line 82
Quoted 10 lines
documentation/sdk-manual/appendix-customizing.rst +3
-3will need to append a value using either "_append" or the "+=" - operator. You can learn more about these operators in the " - Basic Syntax - " section of the BitBake User Manual. + operator. You can learn more about these operators in the + ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" + section of the BitBake User Manual. .
This seems like a spurious dot. (not introduced by your patch, I know :) )
Looks good otherwise, did you check that it's referring to the same page we had in earlier docs? I often check by going on
https://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html
and click on links and check if the reference I'm giving is the expected one.
Cheers,
Quentin
Michael Opdenacker
AppliedHi Quentin,
Many thanks for the review!
Quoted 28 lines · Quentin Schulz
Hi Michael,
Quoted 25 lines · Michael Opdenacker
Detected by running:
git grep "^[\ ]*\" section" | grep -v "\`"Signed-off-by Michael Opdenacker <[email protected]>--- .../sdk-manual/appendix-customizing.rst | 12 ++++++------ documentation/sdk-manual/extensible.rst | 17 ++++++++--------- documentation/sdk-manual/working-projects.rst | 5 ++--- 3 files changed, 16 insertions(+), 18 deletions(-)documentation/sdk-manual/appendix-customizing.rst +3
-3@@ -74,9 +74,9 @@ adjustments: is set using the "?=" operator. Consequently, you will need to either define the entire list by using the "=" operator, or you will need to append a value using either "_append" or the "+=" - operator. You can learn more about these operators in the " - Basic Syntax - " section of the BitBake User Manual. + operator. You can learn more about these operators in the + ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" + section of the BitBake User Manual.
Quoted 3 lines
documentation/sdk-manual/appendix-customizing.rst adjustments: · line 82
Quoted 2 lines
documentation/sdk-manual/appendix-customizing.rst +0
-0.This seems like a spurious dot. (not introduced by your patch, I know :) )
Right! I caught it, but I wanted to address it through a separate patch. I suspected you would catch it :-)
Quoted 6 lines
Looks good otherwise, did you check that it's referring to the same page we had in earlier docs? I often check by going on
https://www.yoctoproject.org/docs/current/mega-manual/mega-manual.html
and click on links and check if the reference I'm giving is the expected one.
No, thanks for the reminder. I double checked and will try to remember to do it from now on.
I merged this patch into "master-next".
Thanks again,
Michael.
Signature · 3 lines
Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com