From: Jonathan Corbet <corbet@lwn.net>
To: Changbin Du <changbin.du@gmail.com>
Cc: linux-pci@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-mm@kvack.org,
linux-crypto@vger.kernel.org, linux-kselftest@vger.kernel.org,
linux-wireless@vger.kernel.org, linux-fpga@vger.kernel.org,
linux-usb@vger.kernel.org, dri-devel@lists.freedesktop.org,
intel-gfx@lists.freedesktop.org
Subject: Re: [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific'
Date: Tue, 15 Oct 2019 12:27:26 -0600 [thread overview]
Message-ID: <20191015122726.7e12f551@lwn.net> (raw)
In-Reply-To: <20191013055359.23312-1-changbin.du@gmail.com>
On Sun, 13 Oct 2019 13:53:59 +0800
Changbin Du <changbin.du@gmail.com> wrote:
> The 'functions' directive is not only for functions, but also works for
> structs/unions. So the name is misleading. This patch renames it to
> 'specific', so now we have export/internal/specific directives to limit
> the functions/types to be included in documentation. Meanwhile we improved
> the warning message.
I agree with the others that "specific" doesn't really make things
better. "Interfaces" maybe; otherwise we could go for something like
"filter" or "select".
Paint mine green :)
Whatever we end up with, I think it should be added as a synonym for
"functions". Then the various selectors that are actually pulling out
docs for functions could be changed at leisure - or not at all. I'd
rather not see a big patch changing everything at once.
Thanks,
jon
next prev parent reply other threads:[~2019-10-15 18:27 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-13 5:53 [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific' Changbin Du
2019-10-13 19:29 ` kbuild test robot
2019-10-13 19:29 ` kbuild test robot
2019-10-13 19:29 ` kbuild test robot
2019-10-13 19:29 ` kbuild test robot
2019-10-14 8:59 ` Jani Nikula
2019-10-14 8:59 ` Jani Nikula
2019-10-14 8:59 ` Jani Nikula
2019-10-14 20:48 ` Tim.Bird
2019-10-14 20:48 ` Tim.Bird-7U/KSKJipcs
2019-10-14 20:48 ` Tim.Bird
2019-10-15 3:15 ` Matthew Wilcox
2019-10-15 9:25 ` Thomas Zimmermann
2019-10-15 9:25 ` Thomas Zimmermann
2019-10-15 11:54 ` Matthew Wilcox
2019-10-15 12:08 ` Thomas Zimmermann
2019-10-15 12:08 ` Thomas Zimmermann
2019-10-15 13:19 ` Jani Nikula
2019-10-15 13:19 ` Jani Nikula
2019-10-16 0:03 ` Changbin Du
2019-10-16 0:48 ` Matthew Wilcox
2019-10-16 0:48 ` Matthew Wilcox
2019-10-14 20:26 ` ✗ Fi.CI.CHECKPATCH: warning for " Patchwork
2019-10-14 20:46 ` ✓ Fi.CI.BAT: success " Patchwork
2019-10-15 8:40 ` ✓ Fi.CI.IGT: " Patchwork
2019-10-15 18:27 ` Jonathan Corbet [this message]
2019-10-16 0:10 ` [PATCH] " Changbin Du
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=20191015122726.7e12f551@lwn.net \
--to=corbet@lwn.net \
--cc=changbin.du@gmail.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linux-pci@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=linux-wireless@vger.kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.