Documentation/auxiliary_bus: Clarify auxiliary_device creation
authorIra Weiny <ira.weiny@intel.com>
Thu, 2 Dec 2021 04:42:59 +0000 (20:42 -0800)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 3 Dec 2021 15:41:50 +0000 (16:41 +0100)
commitb247703873c4d5088eee52d7902495b24967ce8e
tree1a8c964c46eb6f38711b0b13af8d830980f820e4
parentf1045056c726440469d89d23c13734bcd6c0d15b
Documentation/auxiliary_bus: Clarify auxiliary_device creation

The documentation for creating an auxiliary device is a 3 step not a 2
step process.  Specifically the requirements of setting the name, id,
dev.release, and dev.parent fields was not clear as a precursor to the '2
step' process documented.

Clarify by declaring this a 3 step process starting with setting the
fields of struct auxiliary_device correctly.

Also add some sample code and tie the change into the rest of the
documentation.

Signed-off-by: Ira Weiny <ira.weiny@intel.com>
Link: https://lore.kernel.org/r/20211202044305.4006853-2-ira.weiny@intel.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/driver-api/auxiliary_bus.rst
drivers/base/auxiliary.c