Skip to content

Commit

Permalink
doc: Regenerate all documentation
Browse files Browse the repository at this point in the history
Prepare for initial 1.0 release

Signed-off-by: Daniel Wagner <dwagner@suse.de>
  • Loading branch information
igaw committed Apr 8, 2022
1 parent 80a5a3d commit 033449f
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 15 deletions.
14 changes: 0 additions & 14 deletions doc/man/nvme_ctrl_get_ana_state.2

This file was deleted.

11 changes: 11 additions & 0 deletions doc/man/nvme_namespace_first_path.2
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions doc/man/nvme_namespace_for_each_path.2
Original file line number Diff line number Diff line change
@@ -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
15 changes: 15 additions & 0 deletions doc/man/nvme_namespace_for_each_path_safe.2
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions doc/man/nvme_namespace_next_path.2
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion doc/man/nvme_scan_topology.2
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 033449f

Please sign in to comment.