Skip to content

Commit 3068bd7

Browse files
committed
fabrics.c: fixup kernel-doc comments
To keep sphinx happy. Signed-off-by: Hannes Reinecke <[email protected]>
1 parent 29198cd commit 3068bd7

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

src/nvme/fabrics.c

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -316,8 +316,10 @@ static int inet6_pton(nvme_root_t r, const char *src, uint16_t port,
316316

317317
/**
318318
* inet_pton_with_scope - convert an IPv4/IPv6 to socket address
319+
* @r: nvme_root_t object
319320
* @af: address family, AF_INET, AF_INET6 or AF_UNSPEC for either
320321
* @src: the start of the address string
322+
* @trsvcid: transport service identifier
321323
* @addr: output socket address
322324
*
323325
* Return 0 on success, errno otherwise.
@@ -842,15 +844,17 @@ static int uuid_from_dmi_entries(char *system_uuid)
842844
return strlen(system_uuid) ? 0 : -ENXIO;
843845
}
844846

847+
#define PATH_DMI_PROD_UUID "/sys/class/dmi/id/product_uuid"
848+
845849
/**
846-
* @brief Get system UUID from /sys/class/dmi/id/product_uuid and fix
847-
* endianess.
850+
* uuid_from_product_uuid() - Get system UUID from product_uuid
851+
* @system_uuid: Where to save the system UUID.
848852
*
849-
* @param system_uuid - Where to save the system UUID.
853+
* Get system UUID from /sys/class/dmi/id/product_uuid and fix
854+
* endianess.
850855
*
851-
* @return 0 on success, -ENXIO otherwise.
856+
* Return: 0 on success, -ENXIO otherwise.
852857
*/
853-
#define PATH_DMI_PROD_UUID "/sys/class/dmi/id/product_uuid"
854858
static int uuid_from_product_uuid(char *system_uuid)
855859
{
856860
FILE *stream = NULL;
@@ -890,12 +894,17 @@ static int uuid_from_product_uuid(char *system_uuid)
890894
}
891895

892896
/**
893-
* @brief The system UUID can be read from two different locations:
897+
* uuid_from_dmi() - read system UUID
898+
* @system_uuid: buffer for the UUID
899+
*
900+
* The system UUID can be read from two different locations:
894901
*
895902
* 1) /sys/class/dmi/id/product_uuid
896903
* 2) /sys/firmware/dmi/entries
897904
*
898905
* Note that the second location is not present on Debian-based systems.
906+
*
907+
* Return: 0 on success, negative errno otherwise.
899908
*/
900909
static int uuid_from_dmi(char *system_uuid)
901910
{

0 commit comments

Comments
 (0)