Re: [docs] [PATCH] manuals: simplify colon usage

From: "Quentin Schulz" <quentin.schulz@streamunlimited.com>
To: Michael Opdenacker <michael.opdenacker@bootlin.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH] manuals: simplify colon usage
Date: Thu, 15 Apr 2021 18:53:34 +0200	[thread overview]
Message-ID: <20210415165334.dg4et6isnz56xzy6@qschulz> (raw)
In-Reply-To: <c0301119-4642-4f26-ce90-71679c433a40@bootlin.com>

Hi Michael,

On Thu, Apr 15, 2021 at 06:14:33PM +0200, Michael Opdenacker wrote:
> 
> On 4/15/21 6:09 PM, Michael Opdenacker wrote:
> > - This replaces instances of ": ::" by "::", which
> >   generates identical HTML output
> 
> I'll propose the same changes to the Bitbake manual :)
> 

Great first patch... but still a few occurences are left :)

It'd be awesome if you could follow up with another patch fixing
`:<newline>::`, see:

➜  documentation git:(master) ✗ ag -Rc ":\n\s*::"
overview-manual/development-environment.rst:2
dev-manual/start.rst:10
dev-manual/qemu.rst:8
dev-manual/common-tasks.rst:340
0001-docs-fix-missing-and-surrounding-references-from-pok.patch:10
sdk-manual/appendix-customizing.rst:9
overview-manual/concepts.rst:17
sdk-manual/using.rst:2
sdk-manual/extensible.rst:27
sdk-manual/working-projects.rst:20
ref-manual/variables.rst:283
ref-manual/migration-2.1.rst:3
ref-manual/terms.rst:1
ref-manual/migration-1.3.rst:1
ref-manual/structure.rst:6
ref-manual/images.rst:1
ref-manual/migration-2.0.rst:3
ref-manual/migration-2.2.rst:4
ref-manual/migration-3.1.rst:1
ref-manual/features.rst:1
ref-manual/migration-2.5.rst:2
ref-manual/migration-1.7.rst:2
ref-manual/kickstart.rst:2
ref-manual/faq.rst:4
ref-manual/migration-2.3.rst:5
ref-manual/tasks.rst:16
ref-manual/migration-1.4.rst:2
ref-manual/migration-1.6.rst:2
ref-manual/devtool-reference.rst:17
ref-manual/system-requirements.rst:23
ref-manual/migration-2.6.rst:5
ref-manual/classes.rst:29
ref-manual/qa-checks.rst:3
kernel-dev/maint-appx.rst:5
kernel-dev/concepts-appx.rst:2
kernel-dev/advanced.rst:29
kernel-dev/faq.rst:2
kernel-dev/common.rst:75
sdk-manual/appendix-obtain.rst:10

You probably want to use `ag -Rc ":\s*::"` after this patch has been
applied to find all weird corner cases (like, a line ending with `: `.

Also, I think it is time to start a CONTRIBUTING file or whatever the
appropriate name for a file about guidelines would be.

At least, it would help us the day to remember the "rules" once we have
the time to create a linter :)

But not needed for this patch to be merged obviously.

Cheers,
Quentin
-- 
StreamUnlimited Engineering GmbH
High Tech Campus Vienna, Gutheil-Schoder-Gasse 10, 1100 Vienna, Austria
Fax: +43 1 667 20 02 4401
quentin.schulz@streamunlimited.com, www.streamunlimited.com