Commit 4c9a3a6c authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

parport: fix a kernel-doc markup 



The kernel-doc markup inside share.c is actually for
__parport_register_driver. The actual goal seems to be
to document parport_register_driver().

So, fix the existing markup and add a new one.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/dc0778af8c466cc667409ead05876a5cfd3cbece.1610610937.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f7775c20

drivers/parport/share.c

+1 −1
Original line number Diff line number Diff line
@@ -243,7 +243,7 @@ static int port_detect(struct device *dev, void *dev_drv) 
}



/**

 *	parport_register_driver - register a parallel port device driver

 *	__parport_register_driver - register a parallel port device driver

 *	@drv: structure describing the driver

 *	@owner: owner module of drv

 *	@mod_name: module name string

include/linux/parport.h

+31 −0
Original line number Diff line number Diff line
@@ -297,6 +297,37 @@ int __must_check __parport_register_driver(struct parport_driver *, 
 * parport_register_driver must be a macro so that KBUILD_MODNAME can

 * be expanded

 */



/**

 *	parport_register_driver - register a parallel port device driver

 *	@driver: structure describing the driver

 *

 *	This can be called by a parallel port device driver in order

 *	to receive notifications about ports being found in the

 *	system, as well as ports no longer available.

 *

 *	If devmodel is true then the new device model is used

 *	for registration.

 *

 *	The @driver structure is allocated by the caller and must not be

 *	deallocated until after calling parport_unregister_driver().

 *

 *	If using the non device model:

 *	The driver's attach() function may block.  The port that

 *	attach() is given will be valid for the duration of the

 *	callback, but if the driver wants to take a copy of the

 *	pointer it must call parport_get_port() to do so.  Calling

 *	parport_register_device() on that port will do this for you.

 *

 *	The driver's detach() function may block.  The port that

 *	detach() is given will be valid for the duration of the

 *	callback, but if the driver wants to take a copy of the

 *	pointer it must call parport_get_port() to do so.

 *

 *

 *	Returns 0 on success. The non device model will always succeeds.

 *	but the new device model can fail and will return the error code.

 **/

#define parport_register_driver(driver)             \

	__parport_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)