mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
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 5/7] Documentation/auxiliary_bus: Add example code for module_auxiliary_driver()
Date: Wed,  1 Dec 2021 20:43:03 -0800	[thread overview]
Message-ID: <20211202044305.4006853-6-ira.weiny@intel.com> (raw)
In-Reply-To: <20211202044305.4006853-1-ira.weiny@intel.com>

From: Ira Weiny <ira.weiny@intel.com>

Add an example code snipit to the module_auxiliary_driver()
documentation which is consistent with the other example code in the
elsewhere in the documentation.

Signed-off-by: Ira Weiny <ira.weiny@intel.com>
---
 include/linux/auxiliary_bus.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/linux/auxiliary_bus.h b/include/linux/auxiliary_bus.h
index fc51d45f106b..605b27aab693 100644
--- a/include/linux/auxiliary_bus.h
+++ b/include/linux/auxiliary_bus.h
@@ -66,6 +66,10 @@ void auxiliary_driver_unregister(struct auxiliary_driver *auxdrv);
  * Helper macro for auxiliary drivers which do not do anything special in
  * module init/exit. This eliminates a lot of boilerplate. Each module may only
  * use this macro once, and calling it replaces module_init() and module_exit()
+ *
+ * .. code-block:: c
+ *
+ *	module_auxiliary_driver(my_drv);
  */
 #define module_auxiliary_driver(__auxiliary_driver) \
 	module_driver(__auxiliary_driver, auxiliary_driver_register, auxiliary_driver_unregister)
-- 
2.31.1


  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 ` [PATCH V2 4/7] Documentation/auxiliary_bus: Clarify __auxiliary_driver_register ira.weiny
2021-12-02  4:43 ` ira.weiny [this message]
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-6-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®