Re: [docs] [PATCH] dev-manual: fix references to BitBake user manual

[Quentin Schulz <quentin.schulz@theobroma-systems.com>]

Hi Michael,

On 6/10/22 19:17, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Fix a wrong reference
> Add missing double quotes in a reference to a chapter title
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>   documentation/dev-manual/common-tasks.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
> index ca6d594386..7b9fdac10c 100644
> --- a/documentation/dev-manual/common-tasks.rst
> +++ b/documentation/dev-manual/common-tasks.rst
> @@ -2563,7 +2563,7 @@ Recipe Syntax
>   Understanding recipe file syntax is important for writing recipes. The
>   following list overviews the basic items that make up a BitBake recipe
>   file. For more complete BitBake syntax descriptions, see the
> -":doc:`bitbake-user-manual/bitbake-user-manual-metadata`"
> +":doc:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata`"

I don't understand why this is required? Sphinx should find this link 
just fine in the objects.inv from the Bitbake docs if I remember 
correctly? Is this just to have the same "convention" (since we already 
have links using bitbake: in front) or is this actually fixing a bug 
somehow?

If the link was broken, we need to work on running checklinks when 
building the docs so we're aware when links are broken or outdated. 
Well, it's anyways a good idea :)

Cheers,
Quentin