From: ira.weiny@intel.com
To: Jonathan Corbet <corbet@lwn.net>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Ira Weiny <ira.weiny@intel.com>,
Dan Williams <dan.j.williams@intel.com>,
Dave Jiang <dave.jiang@intel.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH V2 4/7] Documentation/auxiliary_bus: Clarify __auxiliary_driver_register
Date: Wed, 1 Dec 2021 20:43:02 -0800 [thread overview]
Message-ID: <20211202044305.4006853-5-ira.weiny@intel.com> (raw)
In-Reply-To: <20211202044305.4006853-1-ira.weiny@intel.com>
From: Ira Weiny <ira.weiny@intel.com>
__auxiliary_driver_register is not intended to be called directly unless
a custom name is required. Add documentation for this fact.
Signed-off-by: Ira Weiny <ira.weiny@intel.com>
---
drivers/base/auxiliary.c | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/drivers/base/auxiliary.c b/drivers/base/auxiliary.c
index 70a8dbcd31b7..7192f7d03a05 100644
--- a/drivers/base/auxiliary.c
+++ b/drivers/base/auxiliary.c
@@ -225,6 +225,11 @@ EXPORT_SYMBOL_GPL(auxiliary_find_device);
* @auxdrv: auxiliary_driver structure
* @owner: owning module/driver
* @modname: KBUILD_MODNAME for parent driver
+ *
+ * The expectation is that users will call the "auxiliary_driver_register"
+ * macro so that the caller's KBUILD_MODNAME is automatically inserted for the
+ * modname parameter. Only if a user requires a custom name would this version
+ * be called directly.
*/
int __auxiliary_driver_register(struct auxiliary_driver *auxdrv,
struct module *owner, const char *modname)
--
2.31.1
next prev parent reply other threads:[~2021-12-02 4:43 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-02 4:42 [PATCH V2 0/7] Improve Auxiliary Bus documentation ira.weiny
2021-12-02 4:42 ` [PATCH V2 1/7] Documentation/auxiliary_bus: Clarify auxiliary_device creation ira.weiny
2021-12-02 4:43 ` [PATCH V2 2/7] Documentation/auxiliary_bus: Clarify match_name ira.weiny
2021-12-02 4:43 ` [PATCH V2 3/7] Documentation/auxiliary_bus: Update Auxiliary device lifespan ira.weiny
2021-12-02 4:43 ` ira.weiny [this message]
2021-12-02 4:43 ` [PATCH V2 5/7] Documentation/auxiliary_bus: Add example code for module_auxiliary_driver() ira.weiny
2021-12-02 4:43 ` [PATCH V2 6/7] Documentation/auxiliary_bus: Clarify the release of devices from find device ira.weiny
2021-12-02 4:43 ` [PATCH V2 7/7] Documentation/auxiliary_bus: Move the text into the code ira.weiny
2021-12-03 15:42 ` [PATCH V2 0/7] Improve Auxiliary Bus documentation Greg Kroah-Hartman
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=20211202044305.4006853-5-ira.weiny@intel.com \
--to=ira.weiny@intel.com \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=dave.jiang@intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®