doc: Regenerate all docs for v1.2

Signed-off-by: Daniel Wagner <[email protected]>

Author: dwsuse

doc/conf.py

@@ -12,7 +12,7 @@
 author = 'Keith Busch <[email protected]>'
 master_doc = 'index'
 
-release = '1.1'
+release = '1.2'
 
 
 # -- General configuration ---------------------------------------------------

doc/config-schema.json

@@ -25,14 +25,14 @@
 		    "description": "NVMe host ID",
 		    "type": "string"
 		},
-		"hostsymname": {
-		    "description": "NVMe host symbolic name",
-		    "type": "string"
-		},
 		"dhchap_key": {
 		    "description": "Host DH-HMAC-CHAP key",
 		    "type": "string"
 		},
+		"hostsymname": {
+		    "description": "NVMe host symbolic name",
+		    "type": "string"
+		},
 		"required": [ "hostnqn" ],
 		"subsystems": {
 		    "description": "Array of NVMe subsystem properties",

doc/man/nvme_admin_opcode.2

@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_admin_opcode" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_admin_opcode" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_admin_opcode \- Known NVMe admin opcodes
 .SH SYNOPSIS

doc/man/nvme_admin_passthru.2

@@ -1,4 +1,4 @@
-.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_admin_passthru \- Submit an nvme passthrough command
 .SH SYNOPSIS

doc/man/nvme_admin_passthru64.2

@@ -0,0 +1,71 @@
+.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
+.SH SYNOPSIS
+.B "int" nvme_admin_passthru64
+.BI "(int fd "  ","
+.BI "__u8 opcode "  ","
+.BI "__u8 flags "  ","
+.BI "__u16 rsvd "  ","
+.BI "__u32 nsid "  ","
+.BI "__u32 cdw2 "  ","
+.BI "__u32 cdw3 "  ","
+.BI "__u32 cdw10 "  ","
+.BI "__u32 cdw11 "  ","
+.BI "__u32 cdw12 "  ","
+.BI "__u32 cdw13 "  ","
+.BI "__u32 cdw14 "  ","
+.BI "__u32 cdw15 "  ","
+.BI "__u32 data_len "  ","
+.BI "void *data "  ","
+.BI "__u32 metadata_len "  ","
+.BI "void *metadata "  ","
+.BI "__u32 timeout_ms "  ","
+.BI "__u64 *result "  ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "opcode" 12
+The nvme io command to send
+.IP "flags" 12
+NVMe command flags (not used)
+.IP "rsvd" 12
+Reserved for future use
+.IP "nsid" 12
+Namespace identifier
+.IP "cdw2" 12
+Command dword 2
+.IP "cdw3" 12
+Command dword 3
+.IP "cdw10" 12
+Command dword 10
+.IP "cdw11" 12
+Command dword 11
+.IP "cdw12" 12
+Command dword 12
+.IP "cdw13" 12
+Command dword 13
+.IP "cdw14" 12
+Command dword 14
+.IP "cdw15" 12
+Command dword 15
+.IP "data_len" 12
+Length of the data transferred in this command in bytes
+.IP "data" 12
+Pointer to user address of the data buffer
+.IP "metadata_len" 12
+Length of metadata transferred in this command
+.IP "metadata" 12
+Pointer to user address of the metadata buffer
+.IP "timeout_ms" 12
+How long the kernel waits for the command to complete
+.IP "result" 12
+Optional field to return the result from the CQE dword 0
+.SH "DESCRIPTION"
+Parameterized form of \fBnvme_submit_admin_passthru64\fP. This sets up and
+submits a \fIstruct nvme_passthru_cmd64\fP.
+
+Known values for \fIopcode\fP are defined in \fIenum nvme_admin_opcode\fP.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.

doc/man/nvme_ae_info_css_nvm.2

@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
 .SH SYNOPSIS

doc/man/nvme_ae_info_error.2

@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_error" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_error" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
 .SH SYNOPSIS

doc/man/nvme_ae_info_notice.2

@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_notice" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_notice" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
 .SH SYNOPSIS

doc/man/nvme_ae_info_smart.2

@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_smart" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_smart" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
 .SH SYNOPSIS

doc/man/nvme_ae_type.2

@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_type" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_type" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_type \- Asynchronous Event Type
 .SH SYNOPSIS