doc: update to c5487d6b6aee89931b68841afbb50f0dceb73da7

Change-Id: I09bbff42df81a9312ad80845843eed886c322684
Signed-off-by: spdkci <sys_sgci@intel.com>

_doc_version.txt

@@ -1 +1 @@
-06472fb6d0c234046253a9989fef790e0cbb219e
+c5487d6b6aee89931b68841afbb50f0dceb73da7

doc/accel_8h.js

@@ -30,12 +30,12 @@ var accel_8h =
       [ "SPDK_ACCEL_OPC_DIF_GENERATE_COPY", "accel_8h.html#a9b864a9a46bd4d2e0612d55cf682bc71a5f18683efef61522edb8b747c3c8b408", null ],
       [ "SPDK_ACCEL_OPC_LAST", "accel_8h.html#a9b864a9a46bd4d2e0612d55cf682bc71a8efd6d3794dd7d83bb2f70387b69a60e", null ]
     ] ],
-    [ "spdk_accel_append_copy", "accel_8h.html#a51ed9c807379914cef1c5eaf05a3b9f7", null ],
+    [ "spdk_accel_append_copy", "accel_8h.html#aae669393a2c7c74cdfbd05216d41a086", null ],
     [ "spdk_accel_append_crc32c", "accel_8h.html#a378b527c7ee062af40c4aef4ea2f4cbc", null ],
-    [ "spdk_accel_append_decompress", "accel_8h.html#af28cbbf84a76a09ad52af0f679f923c4", null ],
-    [ "spdk_accel_append_decrypt", "accel_8h.html#a12a6e4ce53656017f3b01f8cf98fd931", null ],
-    [ "spdk_accel_append_encrypt", "accel_8h.html#a009120c1e212f13b51b808e07d391bc8", null ],
-    [ "spdk_accel_append_fill", "accel_8h.html#a3c286561aa9cbb54d60993fad7b5d98d", null ],
+    [ "spdk_accel_append_decompress", "accel_8h.html#a457e6fd3389ec558b3c6a9f0edf812b0", null ],
+    [ "spdk_accel_append_decrypt", "accel_8h.html#ae6d2130a2163442cb17707e053a63569", null ],
+    [ "spdk_accel_append_encrypt", "accel_8h.html#a090727b328a74d555ae039b9e4462be5", null ],
+    [ "spdk_accel_append_fill", "accel_8h.html#a1c3400c6ae95c73c4fd78adba4bc492a", null ],
     [ "spdk_accel_assign_opc", "accel_8h.html#a040958d2cd363147d686e718edc8a305", null ],
     [ "spdk_accel_crypto_key_create", "accel_8h.html#a32a6e52025120ee79e195d39d83e9147", null ],
     [ "spdk_accel_crypto_key_destroy", "accel_8h.html#a74073c4f0af656c37f348aa3f7ee61d4", null ],
@@ -57,20 +57,20 @@ var accel_8h =
     [ "spdk_accel_set_driver", "accel_8h.html#a142328e0ffe6cf8299dcee984012b660", null ],
     [ "spdk_accel_set_opts", "accel_8h.html#ab32f6cbeb2aeee0a64a268c63a951ec9", null ],
     [ "spdk_accel_submit_compare", "accel_8h.html#a7ba82c135282c35831243dd787fbe907", null ],
-    [ "spdk_accel_submit_compress", "accel_8h.html#a7c7ed1bfb32c852ce8a8ebf67f0ac0ed", null ],
-    [ "spdk_accel_submit_copy", "accel_8h.html#a8414580180688f9334f9a8e3103a6e28", null ],
-    [ "spdk_accel_submit_copy_crc32c", "accel_8h.html#a6e173da38e9c798f949a07149b9bf409", null ],
-    [ "spdk_accel_submit_copy_crc32cv", "accel_8h.html#ad07e15079ef496a54d88a90ef65ab3c6", null ],
+    [ "spdk_accel_submit_compress", "accel_8h.html#a48a72c6a367435bb1a8b079653a61e32", null ],
+    [ "spdk_accel_submit_copy", "accel_8h.html#ac0f663883c7d8087f9b1ca948b3aefc9", null ],
+    [ "spdk_accel_submit_copy_crc32c", "accel_8h.html#a56424bc660d9b1bfe3d6f4ae3976d699", null ],
+    [ "spdk_accel_submit_copy_crc32cv", "accel_8h.html#a40acd298d88d5f41eae9676699b4538f", null ],
     [ "spdk_accel_submit_crc32c", "accel_8h.html#ac4d750dd429c533295e9e73a864eae68", null ],
     [ "spdk_accel_submit_crc32cv", "accel_8h.html#a6273dec7ea700cd19ab055ac08a5a97c", null ],
-    [ "spdk_accel_submit_decompress", "accel_8h.html#ad6de8b2f54bfd1a60203cc845eb01f93", null ],
-    [ "spdk_accel_submit_decrypt", "accel_8h.html#adad68f6857a598ec184c58ace776b05e", null ],
+    [ "spdk_accel_submit_decompress", "accel_8h.html#ae569d84a8960a6e0dc7ed0e0b33102f8", null ],
+    [ "spdk_accel_submit_decrypt", "accel_8h.html#a639cea6588ce2f6f62a894240e466b98", null ],
     [ "spdk_accel_submit_dif_generate", "accel_8h.html#a2d32c08aceebbe4ccb842a33fc3f0e5e", null ],
     [ "spdk_accel_submit_dif_generate_copy", "accel_8h.html#a2289636004169b418ed4e2a86217e4ff", null ],
     [ "spdk_accel_submit_dif_verify", "accel_8h.html#a9c58d3dae8d2ffb15a7cb582ac503bac", null ],
-    [ "spdk_accel_submit_dualcast", "accel_8h.html#aad9824886c1379235c90674e3a932483", null ],
-    [ "spdk_accel_submit_encrypt", "accel_8h.html#afa481210cd4541e79ae4d304f119709e", null ],
-    [ "spdk_accel_submit_fill", "accel_8h.html#ad5529e871a11d307e5aba2e21abeaa29", null ],
+    [ "spdk_accel_submit_dualcast", "accel_8h.html#a402f5ed0f1fac5c37f965a55f0d0bf55", null ],
+    [ "spdk_accel_submit_encrypt", "accel_8h.html#ab071bfaad7673954a9bd6a9ca41f1c77", null ],
+    [ "spdk_accel_submit_fill", "accel_8h.html#adb62b1e99d9a010c140987eea57f5dc4", null ],
     [ "spdk_accel_submit_xor", "accel_8h.html#aed96871d0496c7f6e3549999bbb6ea84", null ],
     [ "spdk_accel_write_config_json", "accel_8h.html#a308671b4f55c2adc9469e59b941a6dcc", null ]
 ];

doc/bdev_8h.html

@@ -515,9 +515,9 @@
 <tr class="memitem:gaca574d3e94be6150343823dd2e7ecf46"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bdev__io__submit__functions.html#gaca574d3e94be6150343823dd2e7ecf46">spdk_bdev_reset</a> (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, <a class="el" href="bdev_8h.html#a0c5602dfd313f90032dd91683b9663e3">spdk_bdev_io_completion_cb</a> cb, void *cb_arg)</td></tr>
 <tr class="memdesc:gaca574d3e94be6150343823dd2e7ecf46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit a reset request to the bdev on the given channel.  <a href="group__bdev__io__submit__functions.html#gaca574d3e94be6150343823dd2e7ecf46">More...</a><br /></td></tr>
 <tr class="separator:gaca574d3e94be6150343823dd2e7ecf46"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a841dcef50460f33c8b5e321e187dc3dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bdev_8h.html#a841dcef50460f33c8b5e321e187dc3dd">spdk_bdev_abort</a> (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *bio_cb_arg, <a class="el" href="bdev_8h.html#a0c5602dfd313f90032dd91683b9663e3">spdk_bdev_io_completion_cb</a> cb, void *cb_arg)</td></tr>
-<tr class="memdesc:a841dcef50460f33c8b5e321e187dc3dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit abort requests to abort all I/Os which has bio_cb_arg as its callback context to the bdev on the given channel.  <a href="bdev_8h.html#a841dcef50460f33c8b5e321e187dc3dd">More...</a><br /></td></tr>
-<tr class="separator:a841dcef50460f33c8b5e321e187dc3dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga841dcef50460f33c8b5e321e187dc3dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bdev__io__submit__functions.html#ga841dcef50460f33c8b5e321e187dc3dd">spdk_bdev_abort</a> (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *bio_cb_arg, <a class="el" href="bdev_8h.html#a0c5602dfd313f90032dd91683b9663e3">spdk_bdev_io_completion_cb</a> cb, void *cb_arg)</td></tr>
+<tr class="memdesc:ga841dcef50460f33c8b5e321e187dc3dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit abort requests to abort all I/Os which has bio_cb_arg as its callback context to the bdev on the given channel.  <a href="group__bdev__io__submit__functions.html#ga841dcef50460f33c8b5e321e187dc3dd">More...</a><br /></td></tr>
+<tr class="separator:ga841dcef50460f33c8b5e321e187dc3dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gae2249ef71e7125338b6cebf935a881ab"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bdev__io__submit__functions.html#gae2249ef71e7125338b6cebf935a881ab">spdk_bdev_nvme_admin_passthru</a> (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, const struct <a class="el" href="structspdk__nvme__cmd.html">spdk_nvme_cmd</a> *cmd, void *buf, size_t nbytes, <a class="el" href="bdev_8h.html#a0c5602dfd313f90032dd91683b9663e3">spdk_bdev_io_completion_cb</a> cb, void *cb_arg)</td></tr>
 <tr class="memdesc:gae2249ef71e7125338b6cebf935a881ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Submit an NVMe Admin command to the bdev.  <a href="group__bdev__io__submit__functions.html#gae2249ef71e7125338b6cebf935a881ab">More...</a><br /></td></tr>
 <tr class="separator:gae2249ef71e7125338b6cebf935a881ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -878,71 +878,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#aedfbfc44fa2113d7ee219d09
 </div>
 </div>
 <h2 class="groupheader">Function Documentation</h2>
-<a id="a841dcef50460f33c8b5e321e187dc3dd"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a841dcef50460f33c8b5e321e187dc3dd">&#9670;&nbsp;</a></span>spdk_bdev_abort()</h2>
-
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int spdk_bdev_abort </td>
-          <td>(</td>
-          <td class="paramtype">struct spdk_bdev_desc *&#160;</td>
-          <td class="paramname"><em>desc</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">struct spdk_io_channel *&#160;</td>
-          <td class="paramname"><em>ch</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">void *&#160;</td>
-          <td class="paramname"><em>bio_cb_arg</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype"><a class="el" href="bdev_8h.html#a0c5602dfd313f90032dd91683b9663e3">spdk_bdev_io_completion_cb</a>&#160;</td>
-          <td class="paramname"><em>cb</em>, </td>
-        </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">void *&#160;</td>
-          <td class="paramname"><em>cb_arg</em>&#160;</td>
-        </tr>
-        <tr>
-          <td></td>
-          <td>)</td>
-          <td></td><td></td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Submit abort requests to abort all I/Os which has bio_cb_arg as its callback context to the bdev on the given channel. </p>
-<p>This goes all the way down to the bdev driver module and attempts to abort all I/Os which have bio_cb_arg as their callback context if they exist. This is a best effort command. Upon completion of this, the status SPDK_BDEV_IO_STATUS_SUCCESS indicates all the I/Os were successfully aborted, or the status SPDK_BDEV_IO_STATUS_FAILED indicates any I/O was failed to abort for any reason or no I/O which has bio_cb_arg as its callback context was found.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">desc</td><td>Block device descriptor. </td></tr>
-    <tr><td class="paramname">ch</td><td>The I/O channel which the I/Os to be aborted are associated with. </td></tr>
-    <tr><td class="paramname">bio_cb_arg</td><td>Callback argument for the outstanding requests which this function attempts to abort. </td></tr>
-    <tr><td class="paramname">cb</td><td>Called when the abort request is completed. </td></tr>
-    <tr><td class="paramname">cb_arg</td><td>Argument passed to cb.</td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>0 on success. On success, the callback will always be called (even if the request ultimately failed). Return negated errno on failure, in which case the callback will not be called.<ul>
-<li>-EINVAL - bio_cb_arg was not specified.</li>
-<li>-ENOMEM - <a class="el" href="structspdk__bdev__io.html">spdk_bdev_io</a> buffer cannot be allocated.</li>
-<li>-ENOTSUP - the bdev does not support abort. </li>
-</ul>
-</dd></dl>
-
-</div>
-</div>
 <a id="a83092483a9de9f7d736ef4ceaaf0d26c"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a83092483a9de9f7d736ef4ceaaf0d26c">&#9670;&nbsp;</a></span>spdk_bdev_channel_get_histogram()</h2>
 

doc/bdev_8h.js

@@ -70,7 +70,7 @@ var bdev_8h =
       [ "SPDK_BDEV_STATUS_UNREGISTERING", "bdev_8h.html#ad6c166f5d928c2995df57c96a2977862a5d925fc967dea1f6d58c0acf82d6ef98", null ],
       [ "SPDK_BDEV_STATUS_REMOVING", "bdev_8h.html#ad6c166f5d928c2995df57c96a2977862a82598753017f84c485785b04f9dcf5fa", null ]
     ] ],
-    [ "spdk_bdev_abort", "bdev_8h.html#a841dcef50460f33c8b5e321e187dc3dd", null ],
+    [ "spdk_bdev_abort", "group__bdev__io__submit__functions.html#ga841dcef50460f33c8b5e321e187dc3dd", null ],
     [ "spdk_bdev_channel_get_histogram", "bdev_8h.html#a83092483a9de9f7d736ef4ceaaf0d26c", null ],
     [ "spdk_bdev_close", "bdev_8h.html#aaf5fc830851a2eb0aa34bbb40cf5eac6", null ],
     [ "spdk_bdev_compare_blocks", "group__bdev__io__submit__functions.html#ga0846ab7b6c938f0f52ac36cd09a75278", null ],

doc/changelog.html

@@ -201,7 +201,7 @@ <h2>nvmf</h2>
 <p>The <code>spdk_nvmf_request::data</code> field has been removed: instead, clients should set <code>-&gt;iov</code> and <code>-&gt;iovcnt</code> appropriately, as nvmf request APIs now expect any data buffers to be described there. <code>spdk_nvmf_request_get_data()</code> has been removed.</p>
 <p><code>transport</code> field in <code>listen_addresses</code> of <code>nvmf_get_subsystems</code> RPC is deprecated. <code>trtype</code> field should be used instead. <code>transport</code> field will be removed in 24.01 release.</p>
 <p>Added <code><a class="el" href="nvmf_8h.html#a264077cd7633ac2103bd4e293e8a94f5" title="Accept new connections on the address provided.">spdk_nvmf_subsystem_add_listener_ext()</a></code> API for accepting new connections on the provided address, now allowing to specify additional options for the listener.</p>
-<p>Deprecated <code><a class="el" href="nvmf_8h.html#afcb0340cf28f2f072bb3fa26c43870ab" title="Check whether a subsystem allows any listen address or only addresses in the allowed list.">spdk_nvmf_subsytem_any_listener_allowed()</a></code> API (to be removed in 24.01) and replaced with <a class="el" href="nvmf_8h.html#a8f4f76f43797274eaf8b08a0894526f6" title="Check whether a subsystem allows any listen address or only addresses in the allowed list.">spdk_nvmf_subsystem_any_listener_allowed()</a>` API fixing the typo.</p>
+<p>Deprecated <code>spdk_nvmf_subsytem_any_listener_allowed()</code> API (to be removed in 24.01) and replaced with <a class="el" href="nvmf_8h.html#a8f4f76f43797274eaf8b08a0894526f6" title="Check whether a subsystem allows any listen address or only addresses in the allowed list.">spdk_nvmf_subsystem_any_listener_allowed()</a>` API fixing the typo.</p>
 <p>Added <code><a class="el" href="nvmf_8h.html#a0241868432ed4cd5687f5add03e52860" title="Checks whether a given subsystem is a discovery subsystem.">spdk_nvmf_subsystem_is_discovery()</a></code> API to check whether a given susbystem is discovery subsystem.</p>
 <h2>scripts</h2>
 <p><code>setup.sh</code> now supports interactive mode for device selection and hugepage reservation.</p>
@@ -344,7 +344,7 @@ <h2>util</h2>
 <p>Added API <code>spdk_strarray_from_string</code>, <code>spdk_strarray_dup</code> and <code>spdk_strarray_free</code> for handling arrays of strings.</p>
 <p>A new API <code>spdk_strcpy_replace</code> was added to replace all occurrences of the search string with the replacement string.</p>
 <p>New API <code><a class="el" href="util_8h.html#a87d0db9f66fa3fc6763dbbe238c3c179" title="Operate like memset across an iovec.">spdk_iov_memset()</a></code> was added to memset an iovec.</p>
-<p>New API <code><a class="el" href="util_8h.html#ae5b9fcc21fe47320520c6d43983ad55f" title="Initialize an iovec with just the single given buffer.">spdk_iov_one()</a></code> was added to initialize an iovec for a single buffer.</p>
+<p>New API <code>spdk_iov_one()</code> was added to initialize an iovec for a single buffer.</p>
 <h1>v22.09</h1>
 <h2>accel</h2>
 <p>Many names were changed in the accel framework to make them consistent both with themselves and the rest of SPDK. The primary public header file is now named <code><a class="el" href="accel_8h.html" title="Acceleration Framework.">include/spdk/accel.h</a></code>.</p>
@@ -1473,7 +1473,7 @@ <h2>NVMe Driver</h2>
 <p>Basic support for Open Channel SSDs was added. See <a class="el" href="nvme__ocssd_8h.html" title="NVMe driver public API extension for Open-Channel.">nvme_ocssd.h</a></p>
 <h2>NVMe Over Fabrics</h2>
 <p>The <a class="el" href="nvmf_8h.html#a21638f4d81002e93d410cd0d267f608c" title="Destroy an NVMe-oF target.">spdk_nvmf_tgt_destroy()</a> function is now asynchronous and takes a callback as a parameter.</p>
-<p><a class="el" href="nvmf_8h.html#afa33cb1cf39e04ee533f874ed82e24e5" title="Disconnect an NVMe-oF qpair.">spdk_nvmf_qpair_disconnect()</a> was added to allow the user to disconnect qpairs.</p>
+<p><a class="el" href="nvmf_8h.html#ab5056f8043ae301e8f79cd96172face9" title="Disconnect an NVMe-oF qpair.">spdk_nvmf_qpair_disconnect()</a> was added to allow the user to disconnect qpairs.</p>
 <p><a class="el" href="nvmf_8h.html#a414b91bad7200ab931f14a06585ccc74" title="Get the maximum number of namespaces allowed in a subsystem.">spdk_nvmf_subsystem_get_max_namespaces()</a> was added to query the maximum allowed number of namespaces for a given subsystem.</p>
 <h2>Build System</h2>
 <p>The build system now generates a combined shared library (libspdk.so) that may be used in place of the individual static libraries (libspdk_*.a). The combined library includes all components of SPDK and is intended to make linking against SPDK easier. The static libraries are also still provided for users that prefer to link only the minimal set of components required.</p>