Skip to content

Commit 8d083ce

Browse files
dwsusedwsuse
committed
doc: Regenerate all documentation
Prepare for next release candiate. Signed-off-by: Daniel Wagner <[email protected]>
1 parent 8ab2ba6 commit 8d083ce

13 files changed

Lines changed: 79 additions & 17 deletions

‎doc/man/nvme_csi.2‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,17 @@ enum nvme_csi {
88
,
99
.br
1010
.br
11+
.BI " NVME_CSI_KV"
12+
,
13+
.br
14+
.br
1115
.BI " NVME_CSI_ZNS"
1216

1317
};
1418
.SH Constants
1519
.IP "NVME_CSI_NVM" 12
1620
NVM Command Set Indicator
21+
.IP "NVME_CSI_KV" 12
22+
Key Value Command Set
1723
.IP "NVME_CSI_ZNS" 12
1824
Zoned Namespace Command Set

‎doc/man/nvme_ctrl_get_ana_state.2‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.TH "nvme_ctrl_get_ana_state" 9 "nvme_ctrl_get_ana_state" "March 2022" "libnvme API manual" LINUX
2+
.SH NAME
3+
nvme_ctrl_get_ana_state \- ANA state of a controller path
4+
.SH SYNOPSIS
5+
.B "const char *" nvme_ctrl_get_ana_state
6+
.BI "(nvme_ctrl_t c " ","
7+
.BI "__u32 nsid " ");"
8+
.SH ARGUMENTS
9+
.IP "c" 12
10+
Constroller instance
11+
.IP "nsid" 12
12+
Namespace ID to evaluate
13+
.SH "RETURN"
14+
ANA state of the namespace \fInsid\fP on controller \fIc\fP.

‎doc/man/nvme_ctrls_filter.2‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "March 2022" "libnvme API manual" LINUX
22
.SH NAME
3-
nvme_ctrls_filter \-
3+
nvme_ctrls_filter \- Filter for controllers
44
.SH SYNOPSIS
55
.B "int" nvme_ctrls_filter
66
.BI "(const struct dirent *d " ");"
77
.SH ARGUMENTS
88
.IP "d" 12
9+
dirent to check
10+
.SH "RETURN"
11+
1 if \fId\fP matches, 0 otherwise

‎doc/man/nvme_identify_cns.2‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ enum nvme_identify_cns {
8888
,
8989
.br
9090
.br
91-
.BI " NVME_IDENTIFY_CNS_CSS_ALLOCATED_NS_LIST"
91+
.BI " NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST"
9292
,
9393
.br
9494
.br
@@ -148,7 +148,7 @@ A UUID List
148148
Domain List
149149
.IP "NVME_IDENTIFY_CNS_ENDURANCE_GROUP_ID" 12
150150
Endurance Group List
151-
.IP "NVME_IDENTIFY_CNS_CSS_ALLOCATED_NS_LIST" 12
151+
.IP "NVME_IDENTIFY_CNS_CSI_ALLOCATED_NS_LIST" 12
152152
I/O Command Set specific Allocated Namespace
153153
ID list
154154
.IP "NVME_IDENTIFY_CNS_COMMAND_SET_STRUCTURE" 12

‎doc/man/nvme_namespace_filter.2‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "March 2022" "libnvme API manual" LINUX
22
.SH NAME
3-
nvme_namespace_filter \-
3+
nvme_namespace_filter \- Filter for namespaces
44
.SH SYNOPSIS
55
.B "int" nvme_namespace_filter
66
.BI "(const struct dirent *d " ");"
77
.SH ARGUMENTS
88
.IP "d" 12
9+
dirent to check
10+
.SH "RETURN"
11+
1 if \fId\fP matches, 0 otherwise

‎doc/man/nvme_paths_filter.2‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
.TH "nvme_paths_filter" 9 "nvme_paths_filter" "March 2022" "libnvme API manual" LINUX
22
.SH NAME
3-
nvme_paths_filter \-
3+
nvme_paths_filter \- Filter for paths
44
.SH SYNOPSIS
55
.B "int" nvme_paths_filter
66
.BI "(const struct dirent *d " ");"
77
.SH ARGUMENTS
88
.IP "d" 12
9+
dirent to check
10+
.SH "RETURN"
11+
1 if \fId\fP matches, 0 otherwise

‎doc/man/nvme_scan_ctrl_namespace_paths.2‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "March 2022" "libnvme API manual" LINUX
22
.SH NAME
3-
nvme_scan_ctrl_namespace_paths \-
3+
nvme_scan_ctrl_namespace_paths \- Scan for namespace paths in a controller
44
.SH SYNOPSIS
55
.B "int" nvme_scan_ctrl_namespace_paths
66
.BI "(nvme_ctrl_t c " ","
7-
.BI "struct dirent ***namespaces " ");"
7+
.BI "struct dirent ***paths " ");"
88
.SH ARGUMENTS
99
.IP "c" 12
10-
.IP "namespaces" 12
10+
Controller to scan
11+
.IP "paths" 12
12+
Pointer to array of dirents
13+
.SH "RETURN"
14+
number of entries in \fIpaths\fP

‎doc/man/nvme_scan_ctrl_namespaces.2‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "March 2022" "libnvme API manual" LINUX
22
.SH NAME
3-
nvme_scan_ctrl_namespaces \-
3+
nvme_scan_ctrl_namespaces \- Scan for namespaces in a controller
44
.SH SYNOPSIS
55
.B "int" nvme_scan_ctrl_namespaces
66
.BI "(nvme_ctrl_t c " ","
7-
.BI "struct dirent ***namespaces " ");"
7+
.BI "struct dirent ***ns " ");"
88
.SH ARGUMENTS
99
.IP "c" 12
10-
.IP "namespaces" 12
10+
Controller to scan
11+
.IP "ns" 12
12+
Pointer to array of dirents
13+
.SH "RETURN"
14+
number of entries in \fIns\fP

‎doc/man/nvme_scan_ctrls.2‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "March 2022" "libnvme API manual" LINUX
22
.SH NAME
3-
nvme_scan_ctrls \-
3+
nvme_scan_ctrls \- Scan for controllers
44
.SH SYNOPSIS
55
.B "int" nvme_scan_ctrls
66
.BI "(struct dirent ***ctrls " ");"
77
.SH ARGUMENTS
88
.IP "ctrls" 12
9+
Pointer to array of dirents
10+
.SH "RETURN"
11+
number of entries in \fIctrls\fP

‎doc/man/nvme_scan_subsystem_namespaces.2‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "March 2022" "libnvme API manual" LINUX
22
.SH NAME
3-
nvme_scan_subsystem_namespaces \-
3+
nvme_scan_subsystem_namespaces \- Scan for namespaces in a subsystem
44
.SH SYNOPSIS
55
.B "int" nvme_scan_subsystem_namespaces
66
.BI "(nvme_subsystem_t s " ","
7-
.BI "struct dirent ***namespaces " ");"
7+
.BI "struct dirent ***ns " ");"
88
.SH ARGUMENTS
99
.IP "s" 12
10-
.IP "namespaces" 12
10+
Subsystem to scan
11+
.IP "ns" 12
12+
-- undescribed --
13+
.SH "RETURN"
14+
number of entries in \fIns\fP

0 commit comments

Comments
 (0)