Merge pull request #209 from hreinecke/doc-proto

Document function prototypes

Author: hreinecke

doc/libnvme.rst

@@ -5643,7 +5643,7 @@ The nvme command status if a response was received (see
 ``nvme_path_t p``
 
 
-.. c:function:: nvme_ctrl_t nvme_path_get_subsystem (nvme_path_t p)
+.. c:function:: nvme_ctrl_t nvme_path_get_ctrl (nvme_path_t p)
 
 
 **Parameters**
@@ -5849,15 +5849,6 @@ The nvme command status if a response was received (see
 .. c:function:: void nvme_refresh_topology (nvme_root_t r)
 
 
-**Parameters**
-
-``nvme_root_t r``
-  *undescribed*
-
-
-.. c:function:: void nvme_reset_topology (nvme_root_t r)
-
-
 **Parameters**
 
 ``nvme_root_t r``

doc/man/nvme_path_get_subsystem.2

@@ -221,16 +221,15 @@ LIBNVME_1_0 {
 		nvme_nvm_identify_ctrl;
 		nvme_open;
 		nvme_path_get_ana_state;
+		nvme_path_get_ctrl;
 		nvme_path_get_name;
 		nvme_path_get_ns;
-		nvme_path_get_subsystem;
 		nvme_path_get_sysfs_dir;
 		nvme_paths_filter;
 		nvme_read;
 		nvme_read_config;
 		nvme_refresh_topology;
 		nvme_rescan_ctrl;
-		nvme_reset_topology;
 		nvme_resv_acquire;
 		nvme_resv_register;
 		nvme_resv_release;

doc/man/nvme_reset_topology.2

@@ -237,15 +237,6 @@ void nvme_refresh_topology(nvme_root_t r)
 	nvme_scan_topology(r, NULL);
 }
 
-void nvme_reset_topology(nvme_root_t r)
-{
-	struct nvme_host *h, *_h;
-
-	nvme_for_each_host_safe(r, h, _h)
-		__nvme_free_host(h);
-	nvme_scan_topology(r, NULL);
-}
-
 void nvme_free_tree(nvme_root_t r)
 {
 	struct nvme_host *h, *_h;
@@ -542,7 +533,7 @@ static int nvme_scan_subsystem(struct nvme_root *r, const char *name,
 	return -1;
 }
 
-nvme_ctrl_t nvme_path_get_subsystem(nvme_path_t p)
+nvme_ctrl_t nvme_path_get_ctrl(nvme_path_t p)
 {
 	return p->c;
 }