From 50bfc12a8a5624c748cbe7952c1d65f1522c141a Mon Sep 17 00:00:00 2001 From: Hannes Reinecke Date: Wed, 2 Feb 2022 11:04:13 +0100 Subject: [PATCH] Fixup sphinx warnings When configuring with 'meson -Dman=true' sphinx is printing out errors on the generated libnvme.rst file. This patch fixes up the function documentations to fixup these warnings. Signed-off-by: Hannes Reinecke --- src/nvme/ioctl.h | 4 ++-- src/nvme/types.h | 6 +++--- src/nvme/util.h | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/nvme/ioctl.h b/src/nvme/ioctl.h index e3c6b7b2..02768097 100644 --- a/src/nvme/ioctl.h +++ b/src/nvme/ioctl.h @@ -2869,7 +2869,7 @@ int nvme_ns_mgmt(struct nvme_ns_mgmt_args *args); * @csi: Command Set Identifier * * On successful creation, the namespace exists in the subsystem, but is not - * attached to any controller. Use the &nvme_ns_attach_ctrls() to assign the + * attached to any controller. Use the nvme_ns_attach_ctrls() to assign the * namespace to one or more controllers. * * Return: The nvme command status if a response was received (see @@ -2898,7 +2898,7 @@ static inline int nvme_ns_mgmt_create(int fd, struct nvme_id_ns *ns, * @nsid: Namespace identifier to delete * * It is recommended that a namespace being deleted is not attached to any - * controller. Use the &nvme_ns_detach_ctrls() first if the namespace is still + * controller. Use the nvme_ns_detach_ctrls() first if the namespace is still * attached. * * Return: The nvme command status if a response was received (see diff --git a/src/nvme/types.h b/src/nvme/types.h index 8afccbde..4542a09a 100644 --- a/src/nvme/types.h +++ b/src/nvme/types.h @@ -677,9 +677,9 @@ enum nvme_psd_workload { * the workload indicated in the Active Power Workload field. * @apws: Bits 7-6: Active Power Scale(APS) indicates the scale for the &struct * nvme_id_psd.actp, see &enum nvme_psd_ps for decoding this value. - * Bits 2-0: Active Power Workload(APW) indicates the workload + * Bits 2-0: Active Power Workload(APW) indicates the workload * used to calculate maximum power for this power state. - * See &enum nvme_psd_workload for decoding this field. + * See &enum nvme_psd_workload for decoding this field. * @rsvd23: Reserved */ struct nvme_id_psd { @@ -773,7 +773,7 @@ struct nvme_id_psd { * condition during which controller operation continues. * @cctemp: Critical Composite Temperature Threshold, field indicates the * minimum Composite Temperature field value (see &struct -* nvme_smart_log.critical_comp_time) that indicates a critical + * nvme_smart_log.critical_comp_time) that indicates a critical * overheating condition. * @mtfa: Maximum Time for Firmware Activation indicates the maximum time * the controller temporarily stops processing commands to activate diff --git a/src/nvme/util.h b/src/nvme/util.h index 1a9567b4..13080317 100644 --- a/src/nvme/util.h +++ b/src/nvme/util.h @@ -81,7 +81,7 @@ const char *nvme_errno_to_string(int err); * @nvmsetid: NVM Set identifer * * This is intended to be used with a namespace management "create", see - * &nvme_ns_mgmt_create(). + * nvme_ns_mgmt_create(). */ void nvme_init_id_ns(struct nvme_id_ns *ns, __u64 nsze, __u64 ncap, __u8 flbas, __u8 dps, __u8 nmic, __u32 anagrpid, __u16 nvmsetid); @@ -93,7 +93,7 @@ void nvme_init_id_ns(struct nvme_id_ns *ns, __u64 nsze, __u64 ncap, __u8 flbas, * @ctrlist: An array of controller identifiers in CPU native endian. * * This is intended to be used with any command that takes a controller list - * argument. See &nvme_ns_attach_ctrls() and &nvme_ns_detach(). + * argument. See nvme_ns_attach_ctrls() and nvme_ns_detach(). */ void nvme_init_ctrl_list(struct nvme_ctrl_list *cntlist, __u16 num_ctrls, __u16 *ctrlist); @@ -107,7 +107,7 @@ void nvme_init_ctrl_list(struct nvme_ctrl_list *cntlist, __u16 num_ctrls, * @nr_ranges: The size of the dsm arrays * * Each array must be the same size of size 'nr_ranges'. This is intended to be - * used with constructing a payload for &nvme_dsm(). + * used with constructing a payload for nvme_dsm(). * * Return: The nvme command status if a response was received or -errno * otherwise. -- 2.50.1