From: Peter Maydell <peter.maydell@linaro.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: qemu-devel@nongnu.org, Paolo Bonzini <pbonzini@redhat.com>,
John Snow <jsnow@redhat.com>
Subject: Re: [PATCH for-10.2 2/8] tests/qtest/libqtest.h: Remove stray space from doc comment
Date: Fri, 15 Aug 2025 11:14:33 +0100 [thread overview]
Message-ID: <CAFEAcA-2d_n-fu4XXssq+xD_nxiozVtBORqVEgZ7RwcNrJ97KQ@mail.gmail.com> (raw)
In-Reply-To: <20250815115132.4af17dfa@foz.lan>
On Fri, 15 Aug 2025 at 10:51, Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> Em Thu, 14 Aug 2025 18:13:17 +0100
> Peter Maydell <peter.maydell@linaro.org> escreveu:
>
> > The doc comment for qtest_cb_for_every_machine has a stray
> > space at the start of its description, which makes kernel-doc
> > think that this line is part of the documentation of the
> > skip_old_versioned argument. The result is that the HTML
> > doesn't have a "Description" section and the text is instead
> > put in the wrong place.
> >
> > Remove the stray space.
> >
> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
>
> LGTM. Even the previous version should have handled it wrong here
> (if not, it is a bug there - or perhaps QEMU version was using
> a very old kernel-doc.pl version).
Yes, the documentation comes out looking wrong on the
old version too -- I only noticed this because I was
examining the diffs of the HTML for before and after
and the exact way it's rendered changed, so it showed up.
Easiest way to reduce the diff was to fix our markup
error :-)
You can see how the old version outputs it at:
https://www.qemu.org/docs/master/devel/testing/qtest.html#c.qtest_cb_for_every_machine
-- PMM
next prev parent reply other threads:[~2025-08-15 10:15 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-14 17:13 [PATCH for-10.2 0/8] docs: Update our kernel-doc script to the kernel's new Python one Peter Maydell
2025-08-14 17:13 ` [PATCH for-10.2 1/8] docs/sphinx/kerneldoc.py: Handle new LINENO syntax Peter Maydell
2025-08-15 9:49 ` Mauro Carvalho Chehab
2025-08-14 17:13 ` [PATCH for-10.2 2/8] tests/qtest/libqtest.h: Remove stray space from doc comment Peter Maydell
2025-08-15 9:51 ` Mauro Carvalho Chehab
2025-08-15 10:14 ` Peter Maydell [this message]
2025-08-14 17:13 ` [PATCH for-10.2 3/8] scripts: Import Python kerneldoc from Linux kernel Peter Maydell
2025-08-15 10:00 ` Mauro Carvalho Chehab
2025-08-15 10:19 ` Peter Maydell
2025-08-14 17:13 ` [PATCH for-10.2 4/8] scripts/kernel-doc: strip QEMU_ from function definitions Peter Maydell
2025-08-15 10:01 ` Mauro Carvalho Chehab
2025-08-14 17:13 ` [PATCH for-10.2 5/8] scripts/kernel-doc: tweak for QEMU coding standards Peter Maydell
2025-08-15 10:34 ` Mauro Carvalho Chehab
2025-08-14 17:13 ` [PATCH for-10.2 6/8] scripts/kerneldoc: Switch to the Python kernel-doc script Peter Maydell
2025-08-14 17:13 ` [PATCH for-10.2 7/8] scripts/kernel-doc: Delete the old Perl " Peter Maydell
2025-08-15 10:35 ` Mauro Carvalho Chehab
2025-08-14 17:13 ` [PATCH for-10.2 8/8] MAINTAINERS: Put kernel-doc under the "docs build machinery" section Peter Maydell
2025-08-15 10:40 ` Mauro Carvalho Chehab
2025-08-26 10:36 ` Peter Maydell
2025-08-15 9:11 ` [PATCH for-10.2 0/8] docs: Update our kernel-doc script to the kernel's new Python one Jonathan Cameron via
2025-08-15 9:39 ` Mauro Carvalho Chehab
2025-08-15 10:10 ` Peter Maydell
2025-08-15 11:12 ` Mauro Carvalho Chehab
2025-08-19 10:34 ` Paolo Bonzini
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=CAFEAcA-2d_n-fu4XXssq+xD_nxiozVtBORqVEgZ7RwcNrJ97KQ@mail.gmail.com \
--to=peter.maydell@linaro.org \
--cc=jsnow@redhat.com \
--cc=mchehab+huawei@kernel.org \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
/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;
as well as URLs for NNTP newsgroup(s).