Commit 38581283 authored by Jiri Slaby's avatar Jiri Slaby Committed by Greg Kroah-Hartman
Browse files

tty: add kernel-doc for more tty_driver functions 



The only documented function for tty_driver structure
allocation/registration was __tty_alloc_driver(). Fix highlighting in
that comment.

And add kernel-doc headers to all tty_driver_kref_put(),
tty_register_driver(), and tty_unregister_driver() -- i.e. the main
ones. More to follow later.

Signed-off-by: default avatarJiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-18-jslaby@suse.cz


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 98629663

drivers/tty/tty_io.c

+14 −2
Original line number Diff line number Diff line
@@ -3394,13 +3394,22 @@ static void destruct_tty_driver(struct kref *kref) 
	kfree(driver);

}



/**

 * tty_driver_kref_put -- drop a reference to a tty driver

 * @driver: driver of which to drop the reference

 *

 * The final put will destroy and free up the driver.

 */

void tty_driver_kref_put(struct tty_driver *driver)

{

	kref_put(&driver->kref, destruct_tty_driver);

}

EXPORT_SYMBOL(tty_driver_kref_put);



/*

/**

 * tty_register_driver -- register a tty driver

 * @driver: driver to register

 *

 * Called by a tty driver to register itself.

 */

int tty_register_driver(struct tty_driver *driver)
@@ -3462,7 +3471,10 @@ int tty_register_driver(struct tty_driver *driver) 
}

EXPORT_SYMBOL(tty_register_driver);



/*

/**

 * tty_unregister_driver -- unregister a tty driver

 * @driver: driver to unregister

 *

 * Called by a tty driver to unregister itself.

 */

void tty_unregister_driver(struct tty_driver *driver)