From: Daniel Wagner <dwagner@suse.de>
Date: Fri, 8 Apr 2022 16:14:55 +0000 (+0200)
Subject: doc: Regenerate all documentation
X-Git-Tag: v1.0^0
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=033449f7c61c130fd21f0a747075dc15069f73f0;p=users%2Fsagi%2Flibnvme.git

doc: Regenerate all documentation

Prepare for initial 1.0 release

Signed-off-by: Daniel Wagner <dwagner@suse.de>
---

diff --git a/doc/man/nvme_ctrl_get_ana_state.2 b/doc/man/nvme_ctrl_get_ana_state.2
deleted file mode 100644
index 565a9233..00000000
--- a/doc/man/nvme_ctrl_get_ana_state.2
+++ /dev/null
@@ -1,14 +0,0 @@
-.TH "nvme_ctrl_get_ana_state" 9 "nvme_ctrl_get_ana_state" "April 2022" "libnvme API manual" LINUX
-.SH NAME
-nvme_ctrl_get_ana_state \- ANA state of a controller path
-.SH SYNOPSIS
-.B "const char *" nvme_ctrl_get_ana_state
-.BI "(nvme_ctrl_t c "  ","
-.BI "__u32 nsid "  ");"
-.SH ARGUMENTS
-.IP "c" 12
-Constroller instance
-.IP "nsid" 12
-Namespace ID to evaluate
-.SH "RETURN"
-ANA state of the namespace \fInsid\fP on controller \fIc\fP.
diff --git a/doc/man/nvme_namespace_first_path.2 b/doc/man/nvme_namespace_first_path.2
new file mode 100644
index 00000000..faaace8e
--- /dev/null
+++ b/doc/man/nvme_namespace_first_path.2
@@ -0,0 +1,11 @@
+.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_namespace_first_path \- Start path iterator
+.SH SYNOPSIS
+.B "nvme_path_t" nvme_namespace_first_path
+.BI "(nvme_ns_t ns "  ");"
+.SH ARGUMENTS
+.IP "ns" 12
+Namespace instance
+.SH "RETURN"
+First \fInvme_path_t\fP object of an \fIns\fP iterator
diff --git a/doc/man/nvme_namespace_for_each_path.2 b/doc/man/nvme_namespace_for_each_path.2
new file mode 100644
index 00000000..c86bb59a
--- /dev/null
+++ b/doc/man/nvme_namespace_for_each_path.2
@@ -0,0 +1,12 @@
+.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_namespace_for_each_path \- Traverse paths
+.SH SYNOPSIS
+.B "nvme_namespace_for_each_path
+.BI "(c "  ","
+.BI "p "  ");"
+.SH ARGUMENTS
+.IP "c" 12
+-- undescribed --
+.IP "p" 12
+\fInvme_path_t\fP object
diff --git a/doc/man/nvme_namespace_for_each_path_safe.2 b/doc/man/nvme_namespace_for_each_path_safe.2
new file mode 100644
index 00000000..9202a274
--- /dev/null
+++ b/doc/man/nvme_namespace_for_each_path_safe.2
@@ -0,0 +1,15 @@
+.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_namespace_for_each_path_safe \- Traverse paths
+.SH SYNOPSIS
+.B "nvme_namespace_for_each_path_safe
+.BI "(n "  ","
+.BI "p "  ","
+.BI "_p "  ");"
+.SH ARGUMENTS
+.IP "n" 12
+-- undescribed --
+.IP "p" 12
+\fInvme_path_t\fP object
+.IP "_p" 12
+A \fInvme_path_t_node\fP to use as temporary storage
diff --git a/doc/man/nvme_namespace_next_path.2 b/doc/man/nvme_namespace_next_path.2
new file mode 100644
index 00000000..a380df3a
--- /dev/null
+++ b/doc/man/nvme_namespace_next_path.2
@@ -0,0 +1,14 @@
+.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_namespace_next_path \- Next path iterator
+.SH SYNOPSIS
+.B "nvme_path_t" nvme_namespace_next_path
+.BI "(nvme_ns_t c "  ","
+.BI "nvme_path_t p "  ");"
+.SH ARGUMENTS
+.IP "c" 12
+-- undescribed --
+.IP "p" 12
+Previous \fInvme_path_t\fP object of an \fIns\fP iterator
+.SH "RETURN"
+Next \fInvme_path_t\fP object of an \fIns\fP iterator
diff --git a/doc/man/nvme_scan_topology.2 b/doc/man/nvme_scan_topology.2
index bee20ebd..602d8aed 100644
--- a/doc/man/nvme_scan_topology.2
+++ b/doc/man/nvme_scan_topology.2
@@ -4,12 +4,15 @@ nvme_scan_topology \- Scan NVMe topology and apply filter
 .SH SYNOPSIS
 .B "int" nvme_scan_topology
 .BI "(nvme_root_t r "  ","
-.BI "nvme_scan_filter_t f "  ");"
+.BI "nvme_scan_filter_t f "  ","
+.BI "void *f_args "  ");"
 .SH ARGUMENTS
 .IP "r" 12
 nvme_root_t object
 .IP "f" 12
 filter to apply
+.IP "f_args" 12
+user-specified argument to \fIf\fP
 .SH "DESCRIPTION"
 Scans the NVMe topology and filters out the resulting elements
 by applying \fIf\fP.