Skip to content

Commit 94dd6d0

Browse files
dwsusedwsuse
committed
doc: Regenerate all docs for v1.3
Signed-off-by: Daniel Wagner <[email protected]>
1 parent 4174de5 commit 94dd6d0

763 files changed

Lines changed: 25528 additions & 721 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/conf.py‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
8+
# -- Project information -----------------------------------------------------
9+
10+
project = 'libnvme'
11+
copyright = '2020, Keith Busch'
12+
author = 'Keith Busch <[email protected]>'
13+
master_doc = 'index'
14+
15+
release = '1.3'
16+
17+
18+
# -- General configuration ---------------------------------------------------
19+
20+
# Add any Sphinx extension module names here, as strings. They can be
21+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
22+
# ones.
23+
extensions = [
24+
]
25+
26+
# Add any paths that contain templates here, relative to this directory.
27+
templates_path = ['_templates']
28+
29+
# List of patterns, relative to source directory, that match files and
30+
# directories to ignore when looking for source files.
31+
# This pattern also affects html_static_path and html_extra_path.
32+
exclude_patterns = ['html', 'man', 'Thumbs.db', '.DS_Store']

‎doc/config-schema.json‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"$id": "https://github.com/linux-nvme/libnvme/doc/config-schema.json",
4+
"title": "config.json",
5+
"description": "libnvme JSON configuration",
6+
"type": "object",
7+
"properties": {
8+
"hosts": {
9+
"description": "Array of NVMe Host properties",
10+
"type": "array",
11+
"items": { "$ref": "#/$defs/host" }
12+
}
13+
},
14+
"$defs": {
15+
"host": {
16+
"description": "NVMe Host properties",
17+
"type": "object",
18+
"properties": {
19+
"hostnqn": {
20+
"description": "NVMe host NQN",
21+
"type": "string",
22+
"maxLength": 223
23+
},
24+
"hostid": {
25+
"description": "NVMe host ID",
26+
"type": "string"
27+
},
28+
"dhchap_key": {
29+
"description": "Host DH-HMAC-CHAP key",
30+
"type": "string"
31+
},
32+
"hostsymname": {
33+
"description": "NVMe host symbolic name",
34+
"type": "string"
35+
},
36+
"persistent_discovery_ctrl": {
37+
"description": "Enable/disable Persistent Discovery Controller",
38+
"type": "boolean"
39+
},
40+
"required": [ "hostnqn" ],
41+
"subsystems": {
42+
"description": "Array of NVMe subsystem properties",
43+
"type": "array",
44+
"items": { "$ref": "#/$defs/subsystem" }
45+
}
46+
}
47+
},
48+
"subsystem": {
49+
"description": "NVMe subsystem properties",
50+
"type": "object",
51+
"properties": {
52+
"nqn": {
53+
"description": "Subsystem NQN",
54+
"type": "string",
55+
"maxLength": 223
56+
},
57+
"ports": {
58+
"description": "Array of NVMe subsystem ports",
59+
"type": "array",
60+
"items": { "$ref": "#/$defs/port" }
61+
},
62+
"required": [ "nqn" ]
63+
}
64+
},
65+
"port": {
66+
"description": "NVMe subsystem port",
67+
"type": "object",
68+
"properties": {
69+
"transport": {
70+
"description": "Transport type",
71+
"type": "string"
72+
},
73+
"traddr": {
74+
"description": "Transport address",
75+
"type": "string"
76+
},
77+
"host_traddr": {
78+
"description": "Host transport address",
79+
"type": "string"
80+
},
81+
"host_iface": {
82+
"description": "Host interface name",
83+
"type": "string"
84+
},
85+
"trsvcid": {
86+
"description": "Transport service identifier",
87+
"type": "string"
88+
},
89+
"dhchap_key": {
90+
"description": "Host DH-HMAC-CHAP key",
91+
"type": "string"
92+
},
93+
"dhchap_ctrl_key": {
94+
"description": "Controller DH-HMAC-CHAP key",
95+
"type": "string"
96+
},
97+
"nr_io_queues": {
98+
"description": "Number of I/O queues",
99+
"type": "integer"
100+
},
101+
"nr_write_queues": {
102+
"description": "Number of write queues",
103+
"type": "integer"
104+
},
105+
"nr_poll_queues": {
106+
"description": "Number of poll queues",
107+
"type": "integer"
108+
},
109+
"queue_size": {
110+
"description": "Queue size",
111+
"type": "integer"
112+
},
113+
"keep_alive_tmo": {
114+
"description": "Keep-Alive timeout (in seconds)",
115+
"type": "integer"
116+
},
117+
"reconnect_delay": {
118+
"description": "Reconnect delay (in seconds)",
119+
"type": "integer"
120+
},
121+
"ctrl_loss_tmo": {
122+
"description": "Controller loss timeout (in seconds)",
123+
"type": "integer"
124+
},
125+
"fast_io_fail_tmo": {
126+
"description": "Fast I/O Fail timeout (in seconds)",
127+
"type": "integer",
128+
"default": 600
129+
},
130+
"tos": {
131+
"description": "Type of service",
132+
"type": "integer",
133+
"default": -1
134+
},
135+
"duplicate_connect": {
136+
"description": "Allow duplicate connections",
137+
"type": "boolean",
138+
"default": false
139+
},
140+
"disable_sqflow": {
141+
"description": "Explicitly disable SQ flow control",
142+
"type": "boolean",
143+
"default": false
144+
},
145+
"hdr_digest": {
146+
"description": "Enable header digest",
147+
"type": "boolean",
148+
"default": false
149+
},
150+
"data_digest": {
151+
"description": "Enable data digest",
152+
"type": "boolean",
153+
"default": false
154+
},
155+
"tls": {
156+
"description": "Enable TLS encryption",
157+
"type": "boolean",
158+
"default": false
159+
},
160+
"persistent": {
161+
"description": "Create persistent discovery connection",
162+
"type": "boolean"
163+
},
164+
"discovery": {
165+
"description": "Connect to a discovery controller",
166+
"type": "boolean"
167+
}
168+
},
169+
"required": [ "transport" ]
170+
}
171+
}
172+
}

‎doc/index.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Welcome to libnvme's documentation!
2+
===================================
3+
4+
This is the libnvme development C library. libnvme provides type definitions for
5+
NVMe specification structures, enumerations, and bit fields,
6+
helper functions to construct, dispatch, and decode commands and payloads,
7+
and utilities to connect, scan, and manage nvme devices on a Linux system.
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
installation.rst
14+
quickstart.rst
15+
mi.rst
16+
api.rst
17+
18+
Indices and tables
19+
==================
20+
21+
* :ref:`genindex`
22+
* :ref:`modindex`
23+
* :ref:`search`

‎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" "October 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_admin_opcode" "January 2023" "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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "October 2022" "libnvme API manual" LINUX
1+
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "January 2023" "libnvme API manual" LINUX
22
.SH NAME
33
nvme_admin_passthru \- Submit an nvme passthrough command
44
.SH SYNOPSIS

‎doc/man/nvme_admin_passthru64.2‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "October 2022" "libnvme API manual" LINUX
1+
.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "January 2023" "libnvme API manual" LINUX
22
.SH NAME
33
nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
44
.SH SYNOPSIS

‎doc/man/nvme_ae_info_css_nvm.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_ae_info_css_nvm" "October 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "January 2023" "API Manual" LINUX
22
.SH NAME
33
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
44
.SH SYNOPSIS

‎doc/man/nvme_ae_info_error.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_ae_info_error" "October 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_error" "January 2023" "API Manual" LINUX
22
.SH NAME
33
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
44
.SH SYNOPSIS

‎doc/man/nvme_ae_info_notice.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_ae_info_notice" "October 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_notice" "January 2023" "API Manual" LINUX
22
.SH NAME
33
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
44
.SH SYNOPSIS

‎doc/man/nvme_ae_info_smart.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_ae_info_smart" "October 2022" "API Manual" LINUX
1+
.TH "libnvme" 9 "enum nvme_ae_info_smart" "January 2023" "API Manual" LINUX
22
.SH NAME
33
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
44
.SH SYNOPSIS

0 commit comments

Comments
 (0)