public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <quentin.schulz@cherry.de>, <docs@lists.yoctoproject.org>
Cc: "Thomas Petazzoni" <thomas.petazzoni@bootlin.com>
Subject: Re: [docs] [PATCH] ref-manual/qa-checks.rst: fix references
Date: Wed, 08 Oct 2025 17:21:06 +0200	[thread overview]
Message-ID: <DDD1JURORMVW.31POTYS7MCXEF@bootlin.com> (raw)
In-Reply-To: <47ff3443-0965-4ba1-a59a-a6461bad613c@cherry.de>

On Wed Oct 8, 2025 at 4:35 PM CEST, Quentin Schulz via lists.yoctoproject.org wrote:
[...]
> For consistency sake, should we always have the error message in a list 
> even if there's only one per section? e.g. ``arch`` has multiple entries 
> in the subsection so we have a dash to specify the start of an item in 
> the list, but ``already-stripped`` only has one, and with the current 
> patch, we don't have a list. Which means a different indentation both in 
> source and in rendered form.

I purposefully created lists only for sections that had multiple possibilities
of error messages. I figured it wasn't necessary to start a list with a single
item.

> [...]
>
>>   .. _qa-check-configure-gettext:
>>   
>> --  ``AM_GNU_GETTEXT used but no inherit gettext [configure-gettext]``
>> +``configure-gettext``
>> +---------------------
>>   
>> -    If a recipe is building something that uses automake and the automake
>> -    files contain an ``AM_GNU_GETTEXT`` directive then this check will fail
>> -    if there is no ``inherit gettext`` statement in the recipe to ensure
>> -    that gettext is available during the build. Add ``inherit gettext`` to
>> -    remove the warning.
>> +``AM_GNU_GETTEXT used but no inherit gettext [configure-gettext]``
>> +
>> + If a recipe is building something that uses automake and the automake
>> + files contain an ``AM_GNU_GETTEXT`` directive then this check will fail
>> + if there is no ``inherit gettext`` statement in the recipe to ensure
>> + that gettext is available during the build. Add ``inherit gettext`` to
>> + remove the warning.
>
> Spurious leading whitespace for the whole paragraph.

Thanks! I tried to remove all of those but missed that one.
Looking for other "^ [a-zA-Z0-9]" patterns I couldn't find any other occurences.

I'll send a v2.

Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com



      reply	other threads:[~2025-10-08 15:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-08 13:33 [PATCH] ref-manual/qa-checks.rst: fix references Antonin Godard
2025-10-08 14:35 ` [docs] " Quentin Schulz
2025-10-08 15:21   ` Antonin Godard [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=DDD1JURORMVW.31POTYS7MCXEF@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=quentin.schulz@cherry.de \
    --cc=thomas.petazzoni@bootlin.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox