Re: [docs] [PATCH 1/2] documentation/README: improve BitBake manual referencing guidelines

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

Hi Michael,

On Tue, Jul 27, 2021 at 04:11:59PM +0200, Michael Opdenacker wrote:
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  documentation/README | 12 ++++++++----
>  1 file changed, 8 insertions(+), 4 deletions(-)
> 
> diff --git a/documentation/README b/documentation/README
> index f9e803a28b..1d4d213076 100644
> --- a/documentation/README
> +++ b/documentation/README
> @@ -328,11 +328,15 @@ The sphinx.ext.intersphinx extension is enabled by default
>  so that we can cross reference content from other Sphinx based
>  documentation projects, such as the BitBake manual.
>  
> -References to the bitbake manual can be done like this:
> -
> -  See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option
> -or
> +References to the BitBake manual can be done:
> + - With a specific description instead of the section name:
> +  :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
> + - With the section name:
> +  ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option
> + - With a BitBake variable name:
>    :term:`bitbake:BB_NUMBER_PARSE_THREADS`

I'd rather not specify bitbake: for terms so that they can be overriden
from within yocto-docs if need be, without needing to modify all the
refs spread over the whole git repo.

Cheers,
Quentin