From: Paolo Bonzini <pbonzini@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards
Date: Mon, 2 Dec 2019 19:17:12 +0100 [thread overview]
Message-ID: <d0e5482b-0e51-a55a-d642-e82ee7700388@redhat.com> (raw)
In-Reply-To: <CAFEAcA-svKVfBGRfwX6d5woqOW0z--rV3-gC9Qi9NqypYfZ=hw@mail.gmail.com>
On 02/12/19 19:01, Peter Maydell wrote:
>> + if (/\s*([\w\s]+?)(\s*-|:)/) {
>> $identifier = $1;
>> }
>>
>> @@ -1888,7 +1896,7 @@ sub process_name($$) {
>> $contents = "";
>> $section = $section_default;
>> $new_start_line = $. + 1;
>> - if (/-(.*)/) {
>> + if (/[-:](.*)/) {
>> # strip leading/trailing/multiple spaces
>> $descr= $1;
>> $descr =~ s/^\s*//;
> These two bits seem to be a third thing not mentioned
> in the commit message -- permitting either colon or
> hyphen in the "Thing: short description" introductory line,
> where kernel style insists on a hyphen.
>
> (You could make the argument that this is an unnecessary
> drift from the kernel-doc style and we should just fix
> up all those colons...)
Perhaps we could yeah. Problem is, there are just three hyphens (one in
include/hw/stream.h, two in include/qemu/host-utils.h) so that would be
quite a big patch. We could do that as we add kernel-doc directive, if
you prefer that, or do it in one shot after committing this series, or
just live with the two lines changed above.
Paolo
next prev parent reply other threads:[~2019-12-02 18:18 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-29 14:02 [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build Paolo Bonzini
2019-11-29 14:02 ` [PATCH 1/8] docs: import Linux kernel-doc script and extension Paolo Bonzini
2019-12-02 17:50 ` Peter Maydell
2019-11-29 14:02 ` [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards Paolo Bonzini
2019-12-02 18:01 ` Peter Maydell
2019-12-02 18:17 ` Paolo Bonzini [this message]
2020-10-02 18:34 ` Eduardo Habkost
2020-10-02 18:43 ` Peter Maydell
2020-10-02 18:46 ` Eduardo Habkost
2020-10-02 18:50 ` Paolo Bonzini
2020-10-02 19:18 ` Eduardo Habkost
2019-11-29 14:02 ` [PATCH 3/8] docs/conf.py: Enable use of kerneldoc sphinx extension Paolo Bonzini
2019-11-29 14:02 ` [PATCH 4/8] Makefile: disable Sphinx nitpicking Paolo Bonzini
2019-11-29 14:02 ` [PATCH 5/8] bitops.h: Silence kernel-doc complaints Paolo Bonzini
2019-11-29 14:02 ` [PATCH 6/8] docs: Create bitops.rst as example of kernel-docs Paolo Bonzini
2019-11-29 14:02 ` [PATCH 7/8] memory.h: Silence kernel-doc complaints Paolo Bonzini
2019-12-02 18:04 ` Peter Maydell
2019-11-29 14:02 ` [PATCH 8/8] docs: add memory API reference Paolo Bonzini
2019-12-02 18:05 ` Peter Maydell
2019-11-30 1:54 ` [PATCH for-5.0 0/8] docs: integrate doc comments with Sphinx build no-reply
2019-12-02 18:06 ` Peter Maydell
2019-12-02 18:13 ` 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=d0e5482b-0e51-a55a-d642-e82ee7700388@redhat.com \
--to=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--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).