Skip to content

Commit

Permalink
doc: Regenerate all documentation
Browse files Browse the repository at this point in the history
Prepare for next release candiate.

Signed-off-by: Daniel Wagner <dwagner@suse.de>
  • Loading branch information
igaw committed Mar 11, 2022
1 parent 8ab2ba6 commit 8d083ce
Show file tree
Hide file tree
Showing 13 changed files with 79 additions and 17 deletions.
6 changes: 6 additions & 0 deletions doc/man/nvme_csi.2
Original file line number Diff line number Diff line change
Expand Up @@ -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
14 changes: 14 additions & 0 deletions doc/man/nvme_ctrl_get_ana_state.2
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 4 additions & 1 deletion doc/man/nvme_ctrls_filter.2
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions doc/man/nvme_identify_cns.2
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion doc/man/nvme_namespace_filter.2
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion doc/man/nvme_paths_filter.2
Original file line number Diff line number Diff line change
@@ -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
10 changes: 7 additions & 3 deletions doc/man/nvme_scan_ctrl_namespace_paths.2
Original file line number Diff line number Diff line change
@@ -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
10 changes: 7 additions & 3 deletions doc/man/nvme_scan_ctrl_namespaces.2
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion doc/man/nvme_scan_ctrls.2
Original file line number Diff line number Diff line change
@@ -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
10 changes: 7 additions & 3 deletions doc/man/nvme_scan_subsystem_namespaces.2
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion doc/man/nvme_scan_subsystems.2
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions doc/man/nvme_status_field.2
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
5 changes: 4 additions & 1 deletion doc/man/nvme_subsys_filter.2
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8d083ce

Please sign in to comment.