fabrics: add documentation to the new discovery/connnect API

Signed-off-by: Daniel Wagner <[email protected]>

Author: igaw

libnvme/src/nvme/fabrics.h

@@ -23,46 +23,6 @@
 /* default to 600 seconds of reconnect attempts before giving up */
 #define NVMF_DEF_CTRL_LOSS_TMO		600
 
-struct nvmf_context;
-
-int nvmf_context_create(struct nvme_global_ctx *ctx,
-		bool (*decide_retry)(struct nvmf_context *fctx, int err,
-			void *user_data),
-		void (*connected)(struct nvmf_context *fctx,
-			struct nvme_ctrl *c, void *user_data),
-		void (*already_connected)(struct nvmf_context *fctx,
-			struct nvme_host *host, const char *subsysnqn,
-			const char *transport, const char *traddr,
-			const char *trsvcid, void *user_data),
-		void *user_data, struct nvmf_context **fctxp);
-int nvmf_context_set_discovery_cbs(struct nvmf_context *fctx,
-		void (*discovery_log)(struct nvmf_context *fctx,
-			bool connect,
-			struct nvmf_discovery_log *log,
-			uint64_t numrec, void *user_data),
-		int (*parser_init)(struct nvmf_context *fctx,
-			void *user_data),
-		void (*parser_cleanup)(struct nvmf_context *fctx,
-			void *user_data),
-		int (*parser_next_line)(struct nvmf_context *fctx,
-			void *user_data));
-int nvmf_context_set_discovery_defaults(struct nvmf_context *fctx,
-		int max_discovery_retries, int keep_alive_timeout);
-int nvmf_context_set_fabrics_config(struct nvmf_context *fctx,
-		struct nvme_fabrics_config *cfg);
-int nvmf_context_set_connection(struct nvmf_context *fctx,
-		const char *subsysnqn, const char *transport,
-		const char *traddr, const char *trsvcid,
-		const char *host_traddr, const char *host_iface);
-int nvmf_context_set_hostnqn(struct nvmf_context *fctx,
-		const char *hostnqn, const char *hostid);
-int nvmf_context_set_crypto(struct nvmf_context *fctx,
-		const char *hostkey, const char *ctrlkey,
-		const char *keyring, const char *tls_key,
-		const char *tls_key_identity);
-int nvmf_context_set_persistent(struct nvmf_context *fctx, bool persistent);
-int nvmf_context_set_device(struct nvmf_context *fctx, const char *device);
-
 /**
  * struct nvme_fabrics_config - Defines all linux nvme fabrics initiator options
  * @queue_size:		Number of IO queue entries
@@ -429,6 +389,46 @@ void nvme_free_uri(struct nvme_fabrics_uri *uri);
 
 char *nvmf_get_default_trsvcid(const char *transport, bool discovery_ctrl);
 
+struct nvmf_context;
+
+int nvmf_context_create(struct nvme_global_ctx *ctx,
+		bool (*decide_retry)(struct nvmf_context *fctx, int err,
+			void *user_data),
+		void (*connected)(struct nvmf_context *fctx,
+			struct nvme_ctrl *c, void *user_data),
+		void (*already_connected)(struct nvmf_context *fctx,
+			struct nvme_host *host, const char *subsysnqn,
+			const char *transport, const char *traddr,
+			const char *trsvcid, void *user_data),
+		void *user_data, struct nvmf_context **fctxp);
+int nvmf_context_set_discovery_cbs(struct nvmf_context *fctx,
+		void (*discovery_log)(struct nvmf_context *fctx,
+			bool connect,
+			struct nvmf_discovery_log *log,
+			uint64_t numrec, void *user_data),
+		int (*parser_init)(struct nvmf_context *fctx,
+			void *user_data),
+		void (*parser_cleanup)(struct nvmf_context *fctx,
+			void *user_data),
+		int (*parser_next_line)(struct nvmf_context *fctx,
+			void *user_data));
+int nvmf_context_set_discovery_defaults(struct nvmf_context *fctx,
+		int max_discovery_retries, int keep_alive_timeout);
+int nvmf_context_set_fabrics_config(struct nvmf_context *fctx,
+		struct nvme_fabrics_config *cfg);
+int nvmf_context_set_connection(struct nvmf_context *fctx,
+		const char *subsysnqn, const char *transport,
+		const char *traddr, const char *trsvcid,
+		const char *host_traddr, const char *host_iface);
+int nvmf_context_set_hostnqn(struct nvmf_context *fctx,
+		const char *hostnqn, const char *hostid);
+int nvmf_context_set_crypto(struct nvmf_context *fctx,
+		const char *hostkey, const char *ctrlkey,
+		const char *keyring, const char *tls_key,
+		const char *tls_key_identity);
+int nvmf_context_set_persistent(struct nvmf_context *fctx, bool persistent);
+int nvmf_context_set_device(struct nvmf_context *fctx, const char *device);
+
 int nvmf_discovery(struct nvme_global_ctx *ctx,
 		struct nvmf_context *fctx, bool connect, bool force);
 int nvmf_discovery_config_json(struct nvme_global_ctx *ctx,