Skip to content

Commit 47e4566

Browse files
committed
Regenerate all documentation
Regenerate documentation for v1.1-rc0 release Signed-off-by: Daniel Wagner <[email protected]>
1 parent e1eaaa6 commit 47e4566

690 files changed

Lines changed: 4913 additions & 4792 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

doc/man/nvme_admin_opcode.2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "libnvme" 9 "enum nvme_admin_opcode" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_admin_opcode" "July 2022" "API Manual" LINUX
22
.SH NAME
33
enum nvme_admin_opcode \- Known NVMe admin opcodes
44
.SH SYNOPSIS

doc/man/nvme_admin_passthru.2

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "April 2022" "libnvme API manual" LINUX
1+
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "July 2022" "libnvme API manual" LINUX
22
.SH NAME
33
nvme_admin_passthru \- Submit an nvme passthrough command
44
.SH SYNOPSIS
@@ -30,7 +30,7 @@ The nvme io command to send
3030
.IP "flags" 12
3131
NVMe command flags (not used)
3232
.IP "rsvd" 12
33-
Reserevd for future use
33+
Reserved for future use
3434
.IP "nsid" 12
3535
Namespace identifier
3636
.IP "cdw2" 12
@@ -50,11 +50,11 @@ Command dword 14
5050
.IP "cdw15" 12
5151
Command dword 15
5252
.IP "data_len" 12
53-
Length of the data transfered in this command in bytes
53+
Length of the data transferred in this command in bytes
5454
.IP "data" 12
5555
Pointer to user address of the data buffer
5656
.IP "metadata_len" 12
57-
Length of metadata transfered in this command
57+
Length of metadata transferred in this command
5858
.IP "metadata" 12
5959
Pointer to user address of the metadata buffer
6060
.IP "timeout_ms" 12

doc/man/nvme_ae_info_css_nvm.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
enum nvme_ae_info_css_nvm \-
3+
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
44
.SH SYNOPSIS
55
enum nvme_ae_info_css_nvm {
66
.br

doc/man/nvme_ae_info_error.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "enum nvme_ae_info_error" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_error" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
enum nvme_ae_info_error \-
3+
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
44
.SH SYNOPSIS
55
enum nvme_ae_info_error {
66
.br

doc/man/nvme_ae_info_notice.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "enum nvme_ae_info_notice" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_notice" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
enum nvme_ae_info_notice \-
3+
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
44
.SH SYNOPSIS
55
enum nvme_ae_info_notice {
66
.br

doc/man/nvme_ae_info_smart.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "enum nvme_ae_info_smart" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_smart" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
enum nvme_ae_info_smart \-
3+
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
44
.SH SYNOPSIS
55
enum nvme_ae_info_smart {
66
.br

doc/man/nvme_ae_type.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "enum nvme_ae_type" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_type" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
enum nvme_ae_type \-
3+
enum nvme_ae_type \- Asynchronous Event Type
44
.SH SYNOPSIS
55
enum nvme_ae_type {
66
.br

doc/man/nvme_aggregate_endurance_group_event.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
struct nvme_aggregate_endurance_group_event \-
3+
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
44
.SH SYNOPSIS
55
struct nvme_aggregate_endurance_group_event {
66
.br

doc/man/nvme_aggregate_predictable_lat_event.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
struct nvme_aggregate_predictable_lat_event \-
3+
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
44
.SH SYNOPSIS
55
struct nvme_aggregate_predictable_lat_event {
66
.br

doc/man/nvme_ana_group_desc.2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.TH "libnvme" 9 "struct nvme_ana_group_desc" "April 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "struct nvme_ana_group_desc" "July 2022" "API Manual" LINUX
22
.SH NAME
3-
struct nvme_ana_group_desc \-
3+
struct nvme_ana_group_desc \- ANA Group Descriptor
44
.SH SYNOPSIS
55
struct nvme_ana_group_desc {
66
.br

0 commit comments

Comments
 (0)