Merge pull request #196 from hreinecke/rc-cleanup

Cleanups for release candidate

Author: hreinecke

doc/man/nvmf_add_ctrl_opts.2

@@ -312,7 +312,6 @@ LIBNVME_1_0 {
 		nvme_zns_mgmt_send;
 		nvme_zns_report_zones;
 		nvmf_add_ctrl;
-		nvmf_add_ctrl_opts;
 		nvmf_adrfam_str;
 		nvmf_cms_str;
 		nvmf_connect_disc_entry;

src/libnvme.map

@@ -553,39 +553,6 @@ static int __nvmf_add_ctrl(const char *argstr)
 	return ret;
 }
 
-int nvmf_add_ctrl_opts(nvme_ctrl_t c, struct nvme_fabrics_config *cfg)
-{
-	nvme_subsystem_t s = nvme_ctrl_get_subsystem(c);
-	nvme_host_t h = nvme_subsystem_get_host(s);
-	char *argstr;
-	int ret;
-
-	cfg = merge_config(c, cfg);
-	if (traddr_is_hostname(c)) {
-		ret = hostname2traddr(c);
-		if (ret) {
-			errno = -ret;
-			return -1;
-		}
-	}
-
-	ret = build_options(h, c, &argstr);
-	if (ret) {
-		errno = -ret;
-		return -1;
-	}
-
-	ret = __nvmf_add_ctrl(argstr);
-	free(argstr);
-	if (ret < 0) {
-		errno = -ret;
-		ret = -1;
-	} else {
-		nvme_msg(LOG_INFO, "nvme%d: ctrl connected\n", ret);
-	}
-	return ret;
-}
-
 int nvmf_add_ctrl(nvme_host_t h, nvme_ctrl_t c,
 		  const struct nvme_fabrics_config *cfg)
 {

src/nvme/fabrics.c

@@ -111,34 +111,46 @@ const char *nvmf_treq_str(__u8 treq);
 const char *nvmf_eflags_str(__u16 eflags);
 
 /**
- * nvmf_sectype_str() -
- * @sectype:
+ * nvmf_sectype_str() - Decode SECTYPE field
+ * @sectype: value to be decoded
  *
- * Return:
+ * Decode the SECTYPE field in the discovery log page
+ * entry.
+ *
+ * Return: decoded string
  */
 const char *nvmf_sectype_str(__u8 sectype);
 
 /**
- * nvmf_prtype_str() -
- * @prtype:
+ * nvmf_prtype_str() - Decode RDMA Provider type field
+ * @prtype: value to be decoded
+ *
+ * Decode the RDMA Provider type field in the discovery
+ * log page entry.
  *
- * Return:
+ * Return: decoded string
  */
 const char *nvmf_prtype_str(__u8 prtype);
 
 /**
- * nvmf_qptype_str() -
- * @qptype:
+ * nvmf_qptype_str() - Decode RDMA QP Service type field
+ * @qptype: value to be decoded
+ *
+ * Decode the RDMA QP Service type field in the discovery log page
+ * entry.
  *
- * Return:
+ * Return: decoded string
  */
 const char *nvmf_qptype_str(__u8 qptype);
 
 /**
- * nvmf_cms_str() -
- * @cms:
+ * nvmf_cms_str() - Decode RDMA connection management service field
+ * @cms: value to be decoded
+ *
+ * Decode the RDMA connection management service field in the discovery
+ * log page entry.
  *
- * Return:
+ * Return: decoded string
  */
 const char *nvmf_cms_str(__u8 cms);
 
@@ -150,15 +162,6 @@ const char *nvmf_cms_str(__u8 cms);
  */
 void nvmf_default_config(struct nvme_fabrics_config *cfg);
 
-/**
- * nvmf_add_ctrl_opts() -
- * @c:
- * @cfg:
- *
- * Return:
- */
-int nvmf_add_ctrl_opts(nvme_ctrl_t c, struct nvme_fabrics_config *cfg);
-
 /**
  * nvmf_add_ctrl() - Connect a controller and update topology
  * @h: Host to which the controller should be attached
@@ -175,12 +178,12 @@ int nvmf_add_ctrl(nvme_host_t h, nvme_ctrl_t c,
 		  const struct nvme_fabrics_config *cfg);
 
 /**
- * nvmf_get_discovery_log() -
- * @c:
- * @logp:
- * @max_retries:
+ * nvmf_get_discovery_log() - Return the discovery log page
+ * @c: Discover controller to use 
+ * @logp: Pointer to the log page to be returned
+ * @max_retries: maximum number of log page entries to be returned
  *
- * Return:
+ * Return: 0 on success; on failure -1 is returned and errno is set
  */
 int nvmf_get_discovery_log(nvme_ctrl_t c, struct nvmf_discovery_log **logp,
 			   int max_retries);
@@ -209,21 +212,21 @@ char *nvmf_hostnqn_from_file();
 char *nvmf_hostid_from_file();
 
 /**
- * nvmf_connect_disc_entry() -
- * @h:
- * @e:
- * @defcfg:
- * @discover:
+ * nvmf_connect_disc_entry() - Connect controller based on the discovery log page entry
+ * @h: Host to which the controller should be connected
+ * @e: Discovery log page entry
+ * @defcfg: Default configurationn to be used for the new controller
+ * @discover: Set to 'true' if the new controller is a discovery controller
  *
- * Return: An 
+ * Return: Pointer to the new controller
  */
 nvme_ctrl_t nvmf_connect_disc_entry(nvme_host_t h,
 	struct nvmf_disc_log_entry *e,
 	const struct nvme_fabrics_config *defcfg, bool *discover);
 
 /**
  * nvme_chomp() - Strip trailing white space
- * &s: String to strip
+ * @s: String to strip
  * @l: Maximum length of string
  */
 static inline void nvme_chomp(char *s, int l)