Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d063623b authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet
Browse files

Documentation: add UUID/GUID to kernel-api 



Update kernel-doc notation in lib/uuid.c and then add UUID/GUID
function interfaces to kernel-api.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
[jc: tweaked the uuid_is_valid() kerneldoc]
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 3abaa5cc

Documentation/core-api/kernel-api.rst

+6 −0
Original line number Diff line number Diff line
@@ -148,6 +148,12 @@ Sorting 
.. kernel-doc:: lib/list_sort.c

   :export:



UUID/GUID

---------



.. kernel-doc:: lib/uuid.c

   :export:



Memory Management in Linux

==========================

lib/uuid.c

+17 −17
Original line number Diff line number Diff line
@@ -29,15 +29,14 @@ EXPORT_SYMBOL(uuid_null); 
const u8 guid_index[16] = {3,2,1,0,5,4,7,6,8,9,10,11,12,13,14,15};

const u8 uuid_index[16] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};



/***************************************************************

/**

 * generate_random_uuid - generate a random UUID

 * @uuid: where to put the generated UUID

 *

 * Random UUID interface

 *

 * Used here for a Boot ID, but can be useful for other kernel

 * drivers.

 ***************************************************************/



/*

 * Generate random UUID

 * Used to create a Boot ID or a filesystem UUID/GUID, but can be

 * useful for other kernel drivers.

 */

void generate_random_uuid(unsigned char uuid[16])

{
@@ -73,12 +72,13 @@ void uuid_gen(uuid_t *bu) 
EXPORT_SYMBOL_GPL(uuid_gen);



/**

  * uuid_is_valid - checks if UUID string valid

 * uuid_is_valid - checks if a UUID string is valid

 * @uuid:	UUID string to check

 *

 * Description:

 * It checks if the UUID string is following the format:

 *	xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

 *

 * where x is a hex digit.

 *

 * Return: true if input is valid UUID string.