Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1414203 > unrolled thread

[PATCH] vme: Update documentation to match api

Back to article view | Back to linux.kernel

Contents

  [PATCH] vme: Update documentation to match api Martyn Welch <martyn@welchs.me.uk> - 2016-06-05 22:40 +0200
    Re: [PATCH] vme: Update documentation to match api Luis de Bethencourt <luisbg@osg.samsung.com> - 2016-06-08 15:40 +0200

#1414203 — [PATCH] vme: Update documentation to match api

The vme_register_driver() api changed in commit 5d6abf379d73 ("staging:
vme: make match() driver specific to improve non-VME64x support") but the
documentation wasn't updated. Update the documentation to match the API.

Signed-off-by: Martyn Welch <martyn@welchs.me.uk>
---
 Documentation/vme_api.txt | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/vme_api.txt b/Documentation/vme_api.txt
index 4ca63a6..9000655 100644
--- a/Documentation/vme_api.txt
+++ b/Documentation/vme_api.txt
@@ -8,13 +8,14 @@ As with other subsystems within the Linux kernel, VME device drivers register
 with the VME subsystem, typically called from the devices init routine.  This is
 achieved via a call to the following function:
 
-	int vme_register_driver (struct vme_driver *driver);
+	int vme_register_driver (struct vme_driver *driver, unsigned int ndevs);
 
 If driver registration is successful this function returns zero, if an error
 occurred a negative error code will be returned.
 
 A pointer to a structure of type 'vme_driver' must be provided to the
-registration function. The structure is as follows:
+registration function. Along with ndevs, which is the number of devices your
+driver is able to support. The structure is as follows:
 
 	struct vme_driver {
 		struct list_head node;
@@ -32,8 +33,8 @@ At the minimum, the '.name', '.match' and '.probe' elements of this structure
 should be correctly set. The '.name' element is a pointer to a string holding
 the device driver's name.
 
-The '.match' function allows controlling the number of devices that need to
-be registered. The match function should return 1 if a device should be
+The '.match' function allows control over which VME devices should be registered
+with the driver. The match function should return 1 if a device should be
 probed and 0 otherwise. This example match function (from vme_user.c) limits
 the number of devices probed to one:
 
-- 
2.1.4

[toc] | [next] | [standalone]

#1417437

On 05/06/16 21:35, Martyn Welch wrote:
> The vme_register_driver() api changed in commit 5d6abf379d73 ("staging:
> vme: make match() driver specific to improve non-VME64x support") but the
> documentation wasn't updated. Update the documentation to match the API.
> 
> Signed-off-by: Martyn Welch <martyn@welchs.me.uk>
> ---

Nice catch :)

Thanks Martyn

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web