Skip to content

Commit

Permalink
doc: update to bc33ed1d9aef8ee7dd4ff4944546143b2108e972
Browse files Browse the repository at this point in the history
Change-Id: Ib31bfd73e986f013fc50c63511aec075bf8158fc
Signed-off-by: spdkci <sys_sgci@intel.com>
  • Loading branch information
spdkci committed May 1, 2024
1 parent 438b45c commit 76b9b30
Show file tree
Hide file tree
Showing 138 changed files with 6,795 additions and 6,440 deletions.
2 changes: 1 addition & 1 deletion _doc_version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
c5487d6b6aee89931b68841afbb50f0dceb73da7
bc33ed1d9aef8ee7dd4ff4944546143b2108e972
43 changes: 22 additions & 21 deletions doc/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -522,27 +522,28 @@
<tr id="row_419_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__file.html" target="_self">spdk_trace_file</a></td><td class="desc"></td></tr>
<tr id="row_420_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__history.html" target="_self">spdk_trace_history</a></td><td class="desc"></td></tr>
<tr id="row_421_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__object.html" target="_self">spdk_trace_object</a></td><td class="desc"></td></tr>
<tr id="row_422_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__owner__type.html" target="_self">spdk_trace_owner_type</a></td><td class="desc"></td></tr>
<tr id="row_423_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__parser__entry.html" target="_self">spdk_trace_parser_entry</a></td><td class="desc">Describes a parsed trace entry </td></tr>
<tr id="row_424_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__parser__opts.html" target="_self">spdk_trace_parser_opts</a></td><td class="desc">Describes trace file and options to use when parsing it </td></tr>
<tr id="row_425_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__register__fn.html" target="_self">spdk_trace_register_fn</a></td><td class="desc"></td></tr>
<tr id="row_426_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__tpoint.html" target="_self">spdk_trace_tpoint</a></td><td class="desc"></td></tr>
<tr id="row_427_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__tpoint__opts.html" target="_self">spdk_trace_tpoint_opts</a></td><td class="desc"></td></tr>
<tr id="row_428_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__uuid.html" target="_self">spdk_uuid</a></td><td class="desc"></td></tr>
<tr id="row_429_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__endpoint__ops.html" target="_self">spdk_vfu_endpoint_ops</a></td><td class="desc"></td></tr>
<tr id="row_430_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__pci__device.html" target="_self">spdk_vfu_pci_device</a></td><td class="desc">Vfio-user PCI device information </td></tr>
<tr id="row_431_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__pci__region.html" target="_self">spdk_vfu_pci_region</a></td><td class="desc">Vfio-user device PCI region </td></tr>
<tr id="row_432_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__sparse__mmap.html" target="_self">spdk_vfu_sparse_mmap</a></td><td class="desc">Vfio-user PCI device sparse MMAP region </td></tr>
<tr id="row_433_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__bitmap.html" target="_self">vfio_user_bitmap</a></td><td class="desc"></td></tr>
<tr id="row_434_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__bitmap__range.html" target="_self">vfio_user_bitmap_range</a></td><td class="desc"></td></tr>
<tr id="row_435_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__device__info.html" target="_self">vfio_user_device_info</a></td><td class="desc"></td></tr>
<tr id="row_436_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__dma__map.html" target="_self">vfio_user_dma_map</a></td><td class="desc"></td></tr>
<tr id="row_437_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__dma__region__access.html" target="_self">vfio_user_dma_region_access</a></td><td class="desc"></td></tr>
<tr id="row_438_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__dma__unmap.html" target="_self">vfio_user_dma_unmap</a></td><td class="desc"></td></tr>
<tr id="row_439_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__header.html" target="_self">vfio_user_header</a></td><td class="desc"></td></tr>
<tr id="row_440_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__irq__info.html" target="_self">vfio_user_irq_info</a></td><td class="desc"></td></tr>
<tr id="row_441_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__region__access.html" target="_self">vfio_user_region_access</a></td><td class="desc"></td></tr>
<tr id="row_442_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__version.html" target="_self">vfio_user_version</a></td><td class="desc"></td></tr>
<tr id="row_422_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__owner.html" target="_self">spdk_trace_owner</a></td><td class="desc"></td></tr>
<tr id="row_423_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__owner__type.html" target="_self">spdk_trace_owner_type</a></td><td class="desc"></td></tr>
<tr id="row_424_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__parser__entry.html" target="_self">spdk_trace_parser_entry</a></td><td class="desc">Describes a parsed trace entry </td></tr>
<tr id="row_425_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__parser__opts.html" target="_self">spdk_trace_parser_opts</a></td><td class="desc">Describes trace file and options to use when parsing it </td></tr>
<tr id="row_426_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__register__fn.html" target="_self">spdk_trace_register_fn</a></td><td class="desc"></td></tr>
<tr id="row_427_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__tpoint.html" target="_self">spdk_trace_tpoint</a></td><td class="desc"></td></tr>
<tr id="row_428_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__trace__tpoint__opts.html" target="_self">spdk_trace_tpoint_opts</a></td><td class="desc"></td></tr>
<tr id="row_429_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__uuid.html" target="_self">spdk_uuid</a></td><td class="desc"></td></tr>
<tr id="row_430_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__endpoint__ops.html" target="_self">spdk_vfu_endpoint_ops</a></td><td class="desc"></td></tr>
<tr id="row_431_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__pci__device.html" target="_self">spdk_vfu_pci_device</a></td><td class="desc">Vfio-user PCI device information </td></tr>
<tr id="row_432_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__pci__region.html" target="_self">spdk_vfu_pci_region</a></td><td class="desc">Vfio-user device PCI region </td></tr>
<tr id="row_433_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspdk__vfu__sparse__mmap.html" target="_self">spdk_vfu_sparse_mmap</a></td><td class="desc">Vfio-user PCI device sparse MMAP region </td></tr>
<tr id="row_434_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__bitmap.html" target="_self">vfio_user_bitmap</a></td><td class="desc"></td></tr>
<tr id="row_435_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__bitmap__range.html" target="_self">vfio_user_bitmap_range</a></td><td class="desc"></td></tr>
<tr id="row_436_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__device__info.html" target="_self">vfio_user_device_info</a></td><td class="desc"></td></tr>
<tr id="row_437_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__dma__map.html" target="_self">vfio_user_dma_map</a></td><td class="desc"></td></tr>
<tr id="row_438_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__dma__region__access.html" target="_self">vfio_user_dma_region_access</a></td><td class="desc"></td></tr>
<tr id="row_439_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__dma__unmap.html" target="_self">vfio_user_dma_unmap</a></td><td class="desc"></td></tr>
<tr id="row_440_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__header.html" target="_self">vfio_user_header</a></td><td class="desc"></td></tr>
<tr id="row_441_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__irq__info.html" target="_self">vfio_user_irq_info</a></td><td class="desc"></td></tr>
<tr id="row_442_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__region__access.html" target="_self">vfio_user_region_access</a></td><td class="desc"></td></tr>
<tr id="row_443_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvfio__user__version.html" target="_self">vfio_user_version</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
1 change: 1 addition & 0 deletions doc/annotated_dup.js
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,7 @@ var annotated_dup =
[ "spdk_trace_file", "structspdk__trace__file.html", "structspdk__trace__file" ],
[ "spdk_trace_history", "structspdk__trace__history.html", "structspdk__trace__history" ],
[ "spdk_trace_object", "structspdk__trace__object.html", "structspdk__trace__object" ],
[ "spdk_trace_owner", "structspdk__trace__owner.html", "structspdk__trace__owner" ],
[ "spdk_trace_owner_type", "structspdk__trace__owner__type.html", "structspdk__trace__owner__type" ],
[ "spdk_trace_parser_entry", "structspdk__trace__parser__entry.html", "structspdk__trace__parser__entry" ],
[ "spdk_trace_parser_opts", "structspdk__trace__parser__opts.html", "structspdk__trace__parser__opts" ],
Expand Down
2 changes: 1 addition & 1 deletion doc/classes.html

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions doc/functions_d.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@
<div class="textblock">Here is a list of all documented struct and union fields with links to the struct/union documentation for each field:</div>

<h3><a id="index_d"></a>- d -</h3><ul>
<li>data
: <a class="el" href="structspdk__trace__file.html#a28999274af3087e6f5d8d26781fc64c9">spdk_trace_file</a>
</li>
<li>data_digest
: <a class="el" href="structspdk__nvme__ctrlr__opts.html#a031524a539fbc57e1ca66c6fef875eea">spdk_nvme_ctrlr_opts</a>
</li>
Expand Down
3 changes: 3 additions & 0 deletions doc/functions_o.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ <h3><a id="index_o"></a>- o -</h3><ul>
, <a class="el" href="structspdk__nvmf__transport__opts.html#ac720992d2cf8950149ab6db89257c98e">spdk_nvmf_transport_opts</a>
, <a class="el" href="structspdk__sock__opts.html#ac8dbf1e759082939e4fc6318122931e7">spdk_sock_opts</a>
</li>
<li>owner_offset
: <a class="el" href="structspdk__trace__file.html#ab30ded0045e75bf5cbce59a25a3cff38">spdk_trace_file</a>
</li>
<li>ozcs
: <a class="el" href="structspdk__nvme__zns__ns__data.html#a6ea0db4f196374061ed80ba87605dc26">spdk_nvme_zns_ns_data</a>
</li>
Expand Down
3 changes: 0 additions & 3 deletions doc/functions_p.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,6 @@ <h3><a id="index_p"></a>- p -</h3><ul>
<li>pending_locked_ranges
: <a class="el" href="structspdk__bdev_1_1____bdev__internal__fields.html#a293999636600108bc77ef672b62bf4f1">spdk_bdev::__bdev_internal_fields</a>
</li>
<li>per_lcore_history
: <a class="el" href="structspdk__trace__file.html#a9335d27363558c9f1c84f566329a485e">spdk_trace_file</a>
</li>
<li>period
: <a class="el" href="structspdk__bdev_1_1____bdev__internal__fields.html#a8155b9ed671033cf7e33d348c49bf980">spdk_bdev::__bdev_internal_fields</a>
</li>
Expand Down
3 changes: 3 additions & 0 deletions doc/functions_vars_d.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@
&#160;

<h3><a id="index_d"></a>- d -</h3><ul>
<li>data
: <a class="el" href="structspdk__trace__file.html#a28999274af3087e6f5d8d26781fc64c9">spdk_trace_file</a>
</li>
<li>data_digest
: <a class="el" href="structspdk__nvme__ctrlr__opts.html#a031524a539fbc57e1ca66c6fef875eea">spdk_nvme_ctrlr_opts</a>
</li>
Expand Down
3 changes: 3 additions & 0 deletions doc/functions_vars_o.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,9 @@ <h3><a id="index_o"></a>- o -</h3><ul>
, <a class="el" href="structspdk__nvmf__transport__opts.html#ac720992d2cf8950149ab6db89257c98e">spdk_nvmf_transport_opts</a>
, <a class="el" href="structspdk__sock__opts.html#ac8dbf1e759082939e4fc6318122931e7">spdk_sock_opts</a>
</li>
<li>owner_offset
: <a class="el" href="structspdk__trace__file.html#ab30ded0045e75bf5cbce59a25a3cff38">spdk_trace_file</a>
</li>
<li>ozcs
: <a class="el" href="structspdk__nvme__zns__ns__data.html#a6ea0db4f196374061ed80ba87605dc26">spdk_nvme_zns_ns_data</a>
</li>
Expand Down
3 changes: 0 additions & 3 deletions doc/functions_vars_p.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,6 @@ <h3><a id="index_p"></a>- p -</h3><ul>
<li>pending_locked_ranges
: <a class="el" href="structspdk__bdev_1_1____bdev__internal__fields.html#a293999636600108bc77ef672b62bf4f1">spdk_bdev::__bdev_internal_fields</a>
</li>
<li>per_lcore_history
: <a class="el" href="structspdk__trace__file.html#a9335d27363558c9f1c84f566329a485e">spdk_trace_file</a>
</li>
<li>period
: <a class="el" href="structspdk__bdev_1_1____bdev__internal__fields.html#a8155b9ed671033cf7e33d348c49bf980">spdk_bdev::__bdev_internal_fields</a>
</li>
Expand Down
4 changes: 2 additions & 2 deletions doc/globals_defs.html
Original file line number Diff line number Diff line change
Expand Up @@ -246,10 +246,10 @@ <h3><a id="index_s"></a>- s -</h3><ul>
: <a class="el" href="crc16_8h.html#a4c5c6b44eafbb4bb09df424150da7508">crc16.h</a>
</li>
<li>spdk_trace_record
: <a class="el" href="trace_8h.html#a583c35dff93e5c996bd7115c4593a457">trace.h</a>
: <a class="el" href="trace_8h.html#a361bd259fb7b5bfd6e420a7475a6e9b1">trace.h</a>
</li>
<li>spdk_trace_record_tsc
: <a class="el" href="trace_8h.html#a9200d8670cb27a4569440782888087e0">trace.h</a>
: <a class="el" href="trace_8h.html#a52e26aba092a343df84ddd528efc6daa">trace.h</a>
</li>
<li>SPDK_VERSION
: <a class="el" href="version_8h.html#af45ea3cba76c12cc449b6556c1982038">version.h</a>
Expand Down
12 changes: 12 additions & 0 deletions doc/globals_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -3820,6 +3820,12 @@ <h3><a id="index_s"></a>- s -</h3><ul>
<li>spdk_trace_mask_usage()
: <a class="el" href="trace_8h.html#a2057ffa0d5eaf0680a8d970646c157af">trace.h</a>
</li>
<li>spdk_trace_owner_append_description()
: <a class="el" href="trace_8h.html#ae6b9e2f687a8aa1003a393de55812e72">trace.h</a>
</li>
<li>spdk_trace_owner_set_description()
: <a class="el" href="trace_8h.html#aa2d823ea98e2e8128d698f32cb7f1472">trace.h</a>
</li>
<li>spdk_trace_parser_cleanup()
: <a class="el" href="trace__parser_8h.html#a4fa645b01c18c3c7b2545fb0bb834c10">trace_parser.h</a>
</li>
Expand Down Expand Up @@ -3847,6 +3853,9 @@ <h3><a id="index_s"></a>- s -</h3><ul>
<li>spdk_trace_register_object()
: <a class="el" href="trace_8h.html#a78c1e25f823c6e98da3f99c515715ebe">trace.h</a>
</li>
<li>spdk_trace_register_owner()
: <a class="el" href="trace_8h.html#a09f16704c4acc63bdbe1d45a7246788f">trace.h</a>
</li>
<li>spdk_trace_register_owner_type()
: <a class="el" href="trace_8h.html#a403d69c1ccce190970051bc2e69b348a">trace.h</a>
</li>
Expand All @@ -3862,6 +3871,9 @@ <h3><a id="index_s"></a>- s -</h3><ul>
<li>spdk_trace_tpoint_register_relation()
: <a class="el" href="trace_8h.html#a0ec4843a02b23b8e0a8f4fe8c91fca3b">trace.h</a>
</li>
<li>spdk_trace_unregister_owner()
: <a class="el" href="trace_8h.html#a8d06cbad5f7d8c4f0cdb8e9a842e8e33">trace.h</a>
</li>
<li>spdk_trace_unregister_user_thread()
: <a class="el" href="trace_8h.html#a2f3c2c36cb52730ac3a98e9d33fd9093">trace.h</a>
</li>
Expand Down
Loading

0 comments on commit 76b9b30

Please sign in to comment.