OSDN Git Service

component: Add documentation
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Thu, 7 Feb 2019 23:27:56 +0000 (00:27 +0100)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Fri, 8 Feb 2019 15:57:38 +0000 (16:57 +0100)
commit4d69c80e0d0fd8cf12d985841eb0fce5c29819ad
tree163bb131a70961025f2f6ca214388583f76d8e3b
parent8834f5600cf3c8db365e18a3d5cac2c2780c81e5
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
Documentation/driver-api/component.rst [new file with mode: 0644]
Documentation/driver-api/device_link.rst
Documentation/driver-api/index.rst
drivers/base/component.c
include/linux/component.h