component: Add documentation
While typing these I think doing an s/component_master/aggregate/ would be useful: - it's shorter :-) - I think component/aggregate is much more meaningful naming than component/puppetmaster or something like that. At least to my English ear "aggregate" emphasizes much more the "assemble a pile of things into something bigger" aspect, and there's not really much of a control hierarchy between aggregate and constituing components. But that's way more than a quick doc typing exercise ... Thanks to Ram for commenting on an initial draft of these docs. v2: Review from Rafael: - git add Documenation/driver-api/component.rst - lots of polish to the wording + spelling fixes. v3: Review from Russell: - s/framework/helper - clarify the documentation for component_match_add functions. v4: Remove a few superflous "This". Reviewed-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Cc: "C, Ramalingam" <ramalingam.c@intel.com> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Russell King <rmk+kernel@arm.linux.org.uk> Cc: Rafael J. Wysocki <rafael@kernel.org> Cc: Jaroslav Kysela <perex@perex.cz> Cc: Takashi Iwai <tiwai@suse.com> Cc: Rodrigo Vivi <rodrigo.vivi@intel.com> Cc: Jani Nikula <jani.nikula@linux.intel.com> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> Link: https://patchwork.freedesktop.org/patch/msgid/20190207232759.14553-1-daniel.vetter@ffwll.ch
This commit is contained in:
17
Documentation/driver-api/component.rst
Normal file
17
Documentation/driver-api/component.rst
Normal file
@@ -0,0 +1,17 @@
|
||||
======================================
|
||||
Component Helper for Aggregate Drivers
|
||||
======================================
|
||||
|
||||
.. kernel-doc:: drivers/base/component.c
|
||||
:doc: overview
|
||||
|
||||
|
||||
API
|
||||
===
|
||||
|
||||
.. kernel-doc:: include/linux/component.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: drivers/base/component.c
|
||||
:export:
|
||||
|
@@ -1,6 +1,9 @@
|
||||
.. |struct dev_pm_domain| replace:: :c:type:`struct dev_pm_domain <dev_pm_domain>`
|
||||
.. |struct generic_pm_domain| replace:: :c:type:`struct generic_pm_domain <generic_pm_domain>`
|
||||
|
||||
|
||||
.. _device_link:
|
||||
|
||||
============
|
||||
Device links
|
||||
============
|
||||
|
@@ -22,6 +22,7 @@ available subsections can be seen below.
|
||||
device_connection
|
||||
dma-buf
|
||||
device_link
|
||||
component
|
||||
message-based
|
||||
sound
|
||||
frame-buffer
|
||||
|
Reference in New Issue
Block a user