SDK manual: fix reference to appendix

Submitted by Michael Opdenacker on March 26, 2021, 10:49 a.m. | Patch ID: 179505

Details

Message ID 20210326104942.13304-1-michael.opdenacker@bootlin.com
State Accepted
Headers show

Commit Message

Michael Opdenacker March 26, 2021, 10:49 a.m.
This fixes https://bugzilla.yoctoproject.org/show_bug.cgi?id=14307

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
---
 documentation/sdk-manual/extensible.rst | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

Patch hide | download patch | download mbox

diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index d2ed9a9b8..f1a114368 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -1271,11 +1271,9 @@  To update your installed SDK, use ``devtool`` as follows:
    $ devtool sdk-update
 
 The previous command assumes your SDK provider has set the
-default update URL for you through the
-:term:`SDK_UPDATE_URL`
-variable as described in the "`Providing Updates to the Extensible SDK
-After
-Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__"
+default update URL for you through the :term:`SDK_UPDATE_URL`
+variable as described in the
+":ref:`sdk-manual/appendix-customizing:Providing Updates to the Extensible SDK After Installation`"
 section. If the SDK provider has not set that default URL, you need to
 specify it yourself in the command as follows: $ devtool sdk-update
 path_to_update_directory

Comments

Quentin Schulz March 26, 2021, 10:59 a.m.
Hi Michael,

On Fri, Mar 26, 2021 at 11:49:42AM +0100, Michael Opdenacker wrote:
> This fixes https://bugzilla.yoctoproject.org/show_bug.cgi?id=14307
> 

Please use [YOCTO #14307] to match the guidelines:
https://docs.yoctoproject.org/dev-manual/common-tasks.html#preparing-changes-for-submission

(Though, there is a mix of "Fixes [YOCTO #14307]" and just "[YOCTO
#14307]").

Not sure there's a need for a v2 just for that, up to Nicolas/Richard.

> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> Reported-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
> ---
>  documentation/sdk-manual/extensible.rst | 8 +++-----
>  1 file changed, 3 insertions(+), 5 deletions(-)
> 
> diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
> index d2ed9a9b8..f1a114368 100644
> --- a/documentation/sdk-manual/extensible.rst
> +++ b/documentation/sdk-manual/extensible.rst
> @@ -1271,11 +1271,9 @@ To update your installed SDK, use ``devtool`` as follows:
>     $ devtool sdk-update
>  
>  The previous command assumes your SDK provider has set the
> -default update URL for you through the
> -:term:`SDK_UPDATE_URL`
> -variable as described in the "`Providing Updates to the Extensible SDK
> -After
> -Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__"
> +default update URL for you through the :term:`SDK_UPDATE_URL`
> +variable as described in the
> +":ref:`sdk-manual/appendix-customizing:Providing Updates to the Extensible SDK After Installation`"

We have PLENTY of those. We absolutely want to get rid of <#...> links.
They are bad. If you have time, it'd be great to fix those.

c.f. https://lists.yoctoproject.org/g/docs/topic/79503023#833

We'll need a linter one day to make sure we don't introduce <#..> links
again (and other stuff, like proper rules).

Anyway, Thanks for the patch :)
Quentin
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#970): https://lists.yoctoproject.org/g/docs/message/970
Mute This Topic: https://lists.yoctoproject.org/mt/81624885/3617530
Group Owner: docs+owner@lists.yoctoproject.org
Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [oe-patchwork@oe-patch.openembedded.org]
-=-=-=-=-=-=-=-=-=-=-=-