Skip to content

Commit

Permalink
doc: Regenerate all docs for v1.9
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Wagner <[email protected]>
  • Loading branch information
igaw committed May 3, 2024
1 parent 61ff3ce commit 80c5cf2
Show file tree
Hide file tree
Showing 879 changed files with 4,482 additions and 881 deletions.
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
author = 'Keith Busch <[email protected]>'
master_doc = 'index'

release = '1.8'
release = '1.9'


# -- General configuration ---------------------------------------------------
Expand Down
16 changes: 8 additions & 8 deletions doc/config-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,14 @@
"description": "Controller DH-HMAC-CHAP key",
"type": "string"
},
"keyring": {
"description": "Keyring for TLS key lookup",
"type": "string"
},
"tls_key": {
"description": "TLS key for the connection",
"type": "string"
},
"nr_io_queues": {
"description": "Number of I/O queues",
"type": "integer"
Expand Down Expand Up @@ -156,14 +164,6 @@
"type": "boolean",
"default": false
},
"keyring": {
"description": "Keyring for TLS key lookup",
"type": "integer"
},
"tls_key": {
"description": "TLS key for the connection",
"type": "integer"
},
"tls": {
"description": "Enable TLS encryption",
"type": "boolean",
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_control.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_control" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_control" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_control \- NBFT Table - Control Descriptor (Figure 8)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_control_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_control_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_control_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_control_flags \- Control Descriptor Flags
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_desc_type.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_desc_type" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_desc_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_desc_type \- NBFT Elements - Descriptor Types (Figure 5)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_discovery.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_discovery" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_discovery" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_discovery \- Discovery Descriptor (Figure 24)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_discovery_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_discovery_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_discovery_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_discovery_flags \- Discovery Descriptor Flags
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_header.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_header" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_header" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_header \- NBFT Table - Header (Figure 8)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_heap_obj.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_heap_obj" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_heap_obj" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_heap_obj \- NBFT Header Driver Signature
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_hfi.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_hfi" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_hfi" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_hfi \- Host Fabric Interface (HFI) Descriptor (Figure 11)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_hfi_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_hfi_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_hfi_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_hfi_flags \- HFI Descriptor Flags
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_hfi_info_tcp.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP (Figure 13)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_hfi_info_tcp_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_hfi_info_tcp_flags \- HFI Transport Flags
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_host.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_host" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_host" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_host \- Host Descriptor (Figure 9)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_host_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_host_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_host_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_host_flags \- Host Flags
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info \- The parsed NBFT table data.
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info_discovery.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_discovery" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_discovery" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_discovery \- Discovery Descriptor
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info_hfi.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_hfi" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_hfi" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_hfi \- Host Fabric Interface (HFI) Descriptor
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info_hfi_info_tcp.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info_host.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_host" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_host" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_host \- Host Descriptor
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info_nid_type.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_info_nid_type" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_info_nid_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_info_nid_type \- Namespace Identifier Type (NIDT)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info_primary_admin_host_flag.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_info_primary_admin_host_flag \- Primary Administrative Host Descriptor Flags
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_info_security.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_security" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_security" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_security \- Security Profile Descriptor
.SH SYNOPSIS
Expand Down
12 changes: 11 additions & 1 deletion doc/man/nbft_info_subsystem_ns.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_subsystem_ns \- Subsystem Namespace (SSNS) info
.SH SYNOPSIS
Expand Down Expand Up @@ -40,6 +40,10 @@ struct nbft_info_subsystem_ns {
.br
.BI " char *dhcp_root_path_string;"
.br
.BI " bool discovered;"
.br
.BI " bool unavailable;"
.br
.BI "
};
.br
Expand Down Expand Up @@ -92,3 +96,9 @@ Descriptor) or 0 if not supported.
.IP "dhcp_root_path_string" 12
DHCP Root Path Override string (SSNS Extended
Information Descriptor).
.IP "discovered" 12
Indicates that this namespace was acquired
through discovery.
.IP "unavailable" 12
Namespace is unavailable as indicated by
the pre-OS driver.
2 changes: 1 addition & 1 deletion doc/man/nbft_security.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_security" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_security" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_security \- Security Profile Descriptor (Figure 21)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_security_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_security_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_security_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_security_flags \- Security Profile Descriptor Flags (Figure 22)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_security_secret_type.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_security_secret_type" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_security_secret_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_security_secret_type \- Security Profile Descriptor Secret Type
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_ssns.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_ssns" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_ssns" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_ssns \- Subsystem Namespace (SSNS) Descriptor (Figure 15)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_ssns_ext_info.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nbft_ssns_ext_info" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nbft_ssns_ext_info" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_ssns_ext_info \- Subsystem and Namespace Extended Information Descriptor (Figure 19)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_ssns_ext_info_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_ssns_ext_info_flags \- Subsystem and Namespace Extended Information Descriptor Flags
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_ssns_flags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_ssns_flags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_ssns_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_ssns_flags \- Subsystem and Namespace Specific Flags Field (Figure 16)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_ssns_trflags.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_ssns_trflags" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_ssns_trflags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_ssns_trflags \- SSNS Transport Specific Flags Field (Figure 17)
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nbft_trtype.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nbft_trtype" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nbft_trtype" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_trtype \- NBFT Interface Transport Types (Figure 7)
.SH SYNOPSIS
Expand Down
12 changes: 12 additions & 0 deletions doc/man/nvme_acq.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.TH "libnvme" 9 "enum nvme_acq" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_acq \- This field indicates the admin completion queue base address
.SH SYNOPSIS
enum nvme_acq {
.br
.BI " NVME_ACQ_ACQB_SHIFT"

};
.SH Constants
.IP "NVME_ACQ_ACQB_SHIFT" 12
Shift amount to get the admin completion queue base
2 changes: 1 addition & 1 deletion doc/man/nvme_admin_opcode.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_admin_opcode" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_admin_opcode" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_admin_opcode \- Known NVMe admin opcodes
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_admin_passthru.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "February 2024" "libnvme API manual" LINUX
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru \- Submit an nvme passthrough command
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_admin_passthru64.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "February 2024" "libnvme API manual" LINUX
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ae_info_css_nvm.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ae_info_error.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_error" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_error" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ae_info_notice.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_notice" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_notice" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ae_info_smart.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_info_smart" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_smart" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ae_type.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ae_type" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_type \- Asynchronous Event Type
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_aggregate_endurance_group_event.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_aggregate_predictable_lat_event.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ana_group_desc.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_ana_group_desc" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_group_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ana_group_desc \- ANA Group Descriptor
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ana_log.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_ana_log" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ana_log \- Asymmetric Namespace Access Log
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_ana_state.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ana_state" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ana_state" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion doc/man/nvme_apst_entry.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_apst_entry" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_apst_entry" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_apst_entry \- Autonomous Power State Transition
.SH SYNOPSIS
Expand Down
30 changes: 30 additions & 0 deletions doc/man/nvme_aqa.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.TH "libnvme" 9 "enum nvme_aqa" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_aqa \- This field indicates the admin queue attributes
.SH SYNOPSIS
enum nvme_aqa {
.br
.BI " NVME_AQA_ASQS_SHIFT"
,
.br
.br
.BI " NVME_AQA_ACQS_SHIFT"
,
.br
.br
.BI " NVME_AQA_ASQS_MASK"
,
.br
.br
.BI " NVME_AQA_ACQS_MASK"

};
.SH Constants
.IP "NVME_AQA_ASQS_SHIFT" 12
Shift amount to get the admin submission queue size
.IP "NVME_AQA_ACQS_SHIFT" 12
Shift amount to get the admin completion queue size
.IP "NVME_AQA_ASQS_MASK" 12
Mask to get the admin submission queue size
.IP "NVME_AQA_ACQS_MASK" 12
Mask to get the admin completion queue size
12 changes: 12 additions & 0 deletions doc/man/nvme_asq.2
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.TH "libnvme" 9 "enum nvme_asq" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_asq \- This field indicates the admin submission queue base address
.SH SYNOPSIS
enum nvme_asq {
.br
.BI " NVME_ASQ_ASQB_SHIFT"

};
.SH Constants
.IP "NVME_ASQ_ASQB_SHIFT" 12
Shift amount to get the admin submission queue base
2 changes: 1 addition & 1 deletion doc/man/nvme_boot_partition.2
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "libnvme" 9 "struct nvme_boot_partition" "February 2024" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_boot_partition" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_boot_partition \- Boot Partition Log
.SH SYNOPSIS
Expand Down
Loading

0 comments on commit 80c5cf2

Please sign in to comment.