Re: [docs] [PATCH] sphinx-lint: various fixes

[Trevor Woerner <twoerner@gmail.com>]

On Mon 2025-05-12 @ 09:50:07 AM, Quentin Schulz wrote:
> Hi Trevor,
> 
> On 5/6/25 8:03 PM, Trevor Woerner via lists.yoctoproject.org wrote:
> > A 'make sphinx-lint' pass found the following issues:
> > 	trailing-whitespace
> > 	missing-space-after-literal
> > 	role-with-double-backticks
> > 	missing-space-before-role (role missing opening tag colon)
> > 
> 
> I'll let Antonin confirm but I assume it would be a good idea to have
> separate commits so we could easily backport them to earlier releases? Or
> maybe you/someone can run sphinx-lint on older releases and send patches for
> those too?

okay, waiting on Antonin

> 
> The changes look fine (and necessary) to me :)
> 
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
> 
> [...]
> 
> > diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
> > index 0f015d434041..21d3dce58c14 100644
> > --- a/documentation/dev-manual/start.rst
> > +++ b/documentation/dev-manual/start.rst
> > @@ -860,7 +860,7 @@ Initializing the Build Environment
> >   Before you can use Yocto you need to setup the build environment.
> >   From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment
> >   setup script to define Yocto Project's build environment on your build host::
> > -
> > -    $ source oe-init-build-env
> > +
> > +    $ source oe-init-build-env
> 
> You could also remove one whitespace before the $ to respect the
> "code-blocks are aligned by three whitespaces" rule we have (and which seems
> to not be part of our documentation/standards.md :) ).

ok

> Thanks!
> Quentin