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 0/7] Improve Auxiliary Bus documentation
Date: Wed,  1 Dec 2021 20:42:58 -0800	[thread overview]
Message-ID: <20211202044305.4006853-1-ira.weiny@intel.com> (raw)

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

The auxiliary bus documentation was not wrong but it was a bit difficult to
follow.  Furthermore the documentation was not tied to the code so it was
potentially harder to maintain.

Add clarifications to ensure that details are not missed.  Move the overview
documentation into the code.  Finally, add some of the existing function
kernel docs into the main Aux Bus section.


Ira Weiny (7):
Documentation/auxiliary_bus: Clarify auxiliary_device creation
Documentation/auxiliary_bus: Clarify match_name
Documentation/auxiliary_bus: Update Auxiliary device lifespan
Documentation/auxiliary_bus: Clarify __auxiliary_driver_register
Documentation/auxiliary_bus: Add example code for
module_auxiliary_driver()
Documentation/auxiliary_bus: Clarify the release of devices from find
device
Documentation/auxiliary_bus: Move the text into the code

Documentation/driver-api/auxiliary_bus.rst | 236 +++------------------
drivers/base/auxiliary.c | 152 ++++++++++++-
include/linux/auxiliary_bus.h | 164 ++++++++++++++
3 files changed, 339 insertions(+), 213 deletions(-)

--
2.31.1


             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 ira.weiny [this message]
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 ` [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-1-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®