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
Message-Id: <20211202044305.4006853-1-ira.weiny@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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