doc: Regenerate all documentation

Prepare for next release candiate.

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

diff --git a/doc/man/nvme_csi.2 b/doc/man/nvme_csi.2
index d40d0e127a2519df5564e91226895852f57dfcf1..1c9482867baa5c8239a1bcb1eeac9e950e6a0e0e 100644 (file)
--- a/doc/man/nvme_csi.2
+++ b/doc/man/nvme_csi.2
@@ -8,11 +8,17 @@ enum nvme_csi {
 , 
 .br
 .br
+.BI "    NVME_CSI_KV"
+, 
+.br
+.br
 .BI "    NVME_CSI_ZNS"
 
 };
 .SH Constants
 .IP "NVME_CSI_NVM" 12
 NVM Command Set Indicator
+.IP "NVME_CSI_KV" 12
+Key Value Command Set
 .IP "NVME_CSI_ZNS" 12
 Zoned Namespace Command Set

diff --git a/doc/man/nvme_ctrl_get_ana_state.2 b/doc/man/nvme_ctrl_get_ana_state.2
new file mode 100644 (file)
index 0000000..9ca3cc7
--- /dev/null
+++ b/doc/man/nvme_ctrl_get_ana_state.2
@@ -0,0 +1,14 @@
+.TH "nvme_ctrl_get_ana_state" 9 "nvme_ctrl_get_ana_state" "March 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_ctrls_filter.2 b/doc/man/nvme_ctrls_filter.2
index e69f89ca3539401094b45cef56413d3210cb6e94..f89b484253fcd0cacc55e607fc65f28808caddee 100644 (file)
--- a/doc/man/nvme_ctrls_filter.2
+++ b/doc/man/nvme_ctrls_filter.2
@@ -1,8 +1,11 @@
 .TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_ctrls_filter \- 
+nvme_ctrls_filter \- Filter for controllers
 .SH SYNOPSIS
 .B "int" nvme_ctrls_filter
 .BI "(const struct dirent *d "  ");"
 .SH ARGUMENTS
 .IP "d" 12
+dirent to check
+.SH "RETURN"
+1 if \fId\fP matches, 0 otherwise

diff --git a/doc/man/nvme_identify_cns.2 b/doc/man/nvme_identify_cns.2
index 1affbf514cf7c9dfd9d8b0500c6cc3ea043559a6..1588166a5e898176a61f8c9dadfa98a9dbebd957 100644 (file)
--- a/doc/man/nvme_identify_cns.2
+++ b/doc/man/nvme_identify_cns.2
@@ -88,7 +88,7 @@ enum nvme_identify_cns {
 , 
 .br
 .br
-.BI "    NVME_IDENTIFY_CNS_CSS_ALLOCATED_NS_LIST"
+.BI "    NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST"
 , 
 .br
 .br
@@ -148,7 +148,7 @@ A UUID List
 Domain List
 .IP "NVME_IDENTIFY_CNS_ENDURANCE_GROUP_ID" 12
 Endurance Group List
-.IP "NVME_IDENTIFY_CNS_CSS_ALLOCATED_NS_LIST" 12
+.IP "NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST" 12
 I/O Command Set specific Allocated Namespace
 ID list
 .IP "NVME_IDENTIFY_CNS_COMMAND_SET_STRUCTURE" 12

diff --git a/doc/man/nvme_namespace_filter.2 b/doc/man/nvme_namespace_filter.2
index da19ca2d5951992beb48e0465747957dc8bf6fa6..a986d4365a47da65e50b6026ba53f7ce16ca7500 100644 (file)
--- a/doc/man/nvme_namespace_filter.2
+++ b/doc/man/nvme_namespace_filter.2
@@ -1,8 +1,11 @@
 .TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_namespace_filter \- 
+nvme_namespace_filter \- Filter for namespaces
 .SH SYNOPSIS
 .B "int" nvme_namespace_filter
 .BI "(const struct dirent *d "  ");"
 .SH ARGUMENTS
 .IP "d" 12
+dirent to check
+.SH "RETURN"
+1 if \fId\fP matches, 0 otherwise

diff --git a/doc/man/nvme_paths_filter.2 b/doc/man/nvme_paths_filter.2
index 38cc53b1d47a7ab1b45592dc42034f2e872c528b..950540af1df2337982e412f6431e3e0797ea925e 100644 (file)
--- a/doc/man/nvme_paths_filter.2
+++ b/doc/man/nvme_paths_filter.2
@@ -1,8 +1,11 @@
 .TH "nvme_paths_filter" 9 "nvme_paths_filter" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_paths_filter \- 
+nvme_paths_filter \- Filter for paths
 .SH SYNOPSIS
 .B "int" nvme_paths_filter
 .BI "(const struct dirent *d "  ");"
 .SH ARGUMENTS
 .IP "d" 12
+dirent to check
+.SH "RETURN"
+1 if \fId\fP matches, 0 otherwise

diff --git a/doc/man/nvme_scan_ctrl_namespace_paths.2 b/doc/man/nvme_scan_ctrl_namespace_paths.2
index 84268e0fa3e575d6b34b4fc6cec34998aef13df8..941da2b6b036f3217fe05d294c2572c3525bcf67 100644 (file)
--- a/doc/man/nvme_scan_ctrl_namespace_paths.2
+++ b/doc/man/nvme_scan_ctrl_namespace_paths.2
@@ -1,10 +1,14 @@
 .TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_scan_ctrl_namespace_paths \- 
+nvme_scan_ctrl_namespace_paths \- Scan for namespace paths in a controller
 .SH SYNOPSIS
 .B "int" nvme_scan_ctrl_namespace_paths
 .BI "(nvme_ctrl_t c "  ","
-.BI "struct dirent ***namespaces "  ");"
+.BI "struct dirent ***paths "  ");"
 .SH ARGUMENTS
 .IP "c" 12
-.IP "namespaces" 12
+Controller to scan
+.IP "paths" 12
+Pointer to array of dirents
+.SH "RETURN"
+number of entries in \fIpaths\fP

diff --git a/doc/man/nvme_scan_ctrl_namespaces.2 b/doc/man/nvme_scan_ctrl_namespaces.2
index 6017002454a785c7d438d63f8837e78437fb14d7..5584a4cb41b224ab892b1affbaf5c1860dc3c743 100644 (file)
--- a/doc/man/nvme_scan_ctrl_namespaces.2
+++ b/doc/man/nvme_scan_ctrl_namespaces.2
@@ -1,10 +1,14 @@
 .TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_scan_ctrl_namespaces \- 
+nvme_scan_ctrl_namespaces \- Scan for namespaces in a controller
 .SH SYNOPSIS
 .B "int" nvme_scan_ctrl_namespaces
 .BI "(nvme_ctrl_t c "  ","
-.BI "struct dirent ***namespaces "  ");"
+.BI "struct dirent ***ns "  ");"
 .SH ARGUMENTS
 .IP "c" 12
-.IP "namespaces" 12
+Controller to scan
+.IP "ns" 12
+Pointer to array of dirents
+.SH "RETURN"
+number of entries in \fIns\fP

diff --git a/doc/man/nvme_scan_ctrls.2 b/doc/man/nvme_scan_ctrls.2
index 7652965ec0fcbbb988d3535c21e4deb14ecbfd66..5f3cd020cd5a6a0231cf0d93c309c73b11fbd92b 100644 (file)
--- a/doc/man/nvme_scan_ctrls.2
+++ b/doc/man/nvme_scan_ctrls.2
@@ -1,8 +1,11 @@
 .TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_scan_ctrls \- 
+nvme_scan_ctrls \- Scan for controllers
 .SH SYNOPSIS
 .B "int" nvme_scan_ctrls
 .BI "(struct dirent ***ctrls "  ");"
 .SH ARGUMENTS
 .IP "ctrls" 12
+Pointer to array of dirents
+.SH "RETURN"
+number of entries in \fIctrls\fP

diff --git a/doc/man/nvme_scan_subsystem_namespaces.2 b/doc/man/nvme_scan_subsystem_namespaces.2
index 2f3906a2df30b0836a25aaa7e0c5dc693c58083f..54e7c0a8afd7c0ab9683ce66e02547e482c2362e 100644 (file)
--- a/doc/man/nvme_scan_subsystem_namespaces.2
+++ b/doc/man/nvme_scan_subsystem_namespaces.2
@@ -1,10 +1,14 @@
 .TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_scan_subsystem_namespaces \- 
+nvme_scan_subsystem_namespaces \- Scan for namespaces in a subsystem
 .SH SYNOPSIS
 .B "int" nvme_scan_subsystem_namespaces
 .BI "(nvme_subsystem_t s "  ","
-.BI "struct dirent ***namespaces "  ");"
+.BI "struct dirent ***ns "  ");"
 .SH ARGUMENTS
 .IP "s" 12
-.IP "namespaces" 12
+Subsystem to scan
+.IP "ns" 12
+-- undescribed --
+.SH "RETURN"
+number of entries in \fIns\fP

diff --git a/doc/man/nvme_scan_subsystems.2 b/doc/man/nvme_scan_subsystems.2
index 3e27006d7cc2b8886e78942c9f5c77ee9fc21a61..fa906734edb057e929781549245e71cc1b8139c6 100644 (file)
--- a/doc/man/nvme_scan_subsystems.2
+++ b/doc/man/nvme_scan_subsystems.2
@@ -1,8 +1,11 @@
 .TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_scan_subsystems \- 
+nvme_scan_subsystems \- Scan for subsystems
 .SH SYNOPSIS
 .B "int" nvme_scan_subsystems
 .BI "(struct dirent ***subsys "  ");"
 .SH ARGUMENTS
 .IP "subsys" 12
+Pointer to array of dirents
+.SH "RETURN"
+number of entries in \fIsubsys\fP

diff --git a/doc/man/nvme_status_field.2 b/doc/man/nvme_status_field.2
index 3d585025dfcc82618d539fd871767813eb41d048..2a1dd262c276b8aab025c77f710a423e735a886a 100644 (file)
--- a/doc/man/nvme_status_field.2
+++ b/doc/man/nvme_status_field.2
@@ -28,10 +28,18 @@ enum nvme_status_field {
 , 
 .br
 .br
+.BI "    NVME_SCT_SHIFT"
+, 
+.br
+.br
 .BI "    NVME_SC_MASK"
 , 
 .br
 .br
+.BI "    NVME_SC_SHIFT"
+, 
+.br
+.br
 .BI "    NVME_SC_SUCCESS"
 , 
 .br
@@ -576,8 +584,12 @@ Errors associated with the paths connection
 Vendor specific errors
 .IP "NVME_SCT_MASK" 12
 Mask to get the value of the Status Code Type
+.IP "NVME_SCT_SHIFT" 12
+-- undescribed --
 .IP "NVME_SC_MASK" 12
 Mask to get the value of the status code.
+.IP "NVME_SC_SHIFT" 12
+-- undescribed --
 .IP "NVME_SC_SUCCESS" 12
 Successful Completion: The command
 completed without error.

diff --git a/doc/man/nvme_subsys_filter.2 b/doc/man/nvme_subsys_filter.2
index 23cf8600dc4bbec4865780a5765ade66704a9123..08375b4c524eb7bc1138ca9f8dbc0338b38efa52 100644 (file)
--- a/doc/man/nvme_subsys_filter.2
+++ b/doc/man/nvme_subsys_filter.2
@@ -1,8 +1,11 @@
 .TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "March 2022" "libnvme API manual" LINUX
 .SH NAME
-nvme_subsys_filter \- 
+nvme_subsys_filter \- Filter for subsystems
 .SH SYNOPSIS
 .B "int" nvme_subsys_filter
 .BI "(const struct dirent *d "  ");"
 .SH ARGUMENTS
 .IP "d" 12
+dirent to check
+.SH "RETURN"
+1 if \fId\fP matches, 0 otherwise