Commit 33dde51f authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

doc: organize Key Functions into tables 



Change-Id: I21ff868ddbea4e6819f74b7b01c344abe532ee19
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent 25d331b2

doc/ioat/index.txt

+6 −4
Original line number Diff line number Diff line
@@ -41,9 +41,11 @@ 


\section ioat_key_functions Key Functions



- spdk_ioat_probe() \copybrief spdk_ioat_probe()

- spdk_ioat_get_dma_capabilities() \copybrief spdk_ioat_get_dma_capabilities()

- spdk_ioat_submit_copy() \copybrief spdk_ioat_submit_copy()

- spdk_ioat_submit_fill() \copybrief spdk_ioat_submit_fill()

Function                                | Description

--------------------------------------- | -----------

spdk_ioat_probe()                       | \copybrief spdk_ioat_probe()

spdk_ioat_get_dma_capabilities()        | \copybrief spdk_ioat_get_dma_capabilities()

spdk_ioat_submit_copy()                 | \copybrief spdk_ioat_submit_copy()

spdk_ioat_submit_fill()                 | \copybrief spdk_ioat_submit_fill()



*/

doc/nvme/index.txt

+8 −6
Original line number Diff line number Diff line
@@ -41,12 +41,14 @@ 


\section nvme_key_functions Key Functions



- spdk_nvme_probe() \copybrief spdk_nvme_probe()

- spdk_nvme_ns_cmd_read() \copybrief spdk_nvme_ns_cmd_read()

- spdk_nvme_ns_cmd_write() \copybrief spdk_nvme_ns_cmd_write()

- spdk_nvme_ns_cmd_deallocate() \copybrief spdk_nvme_ns_cmd_deallocate()

- spdk_nvme_ns_cmd_flush() \copybrief spdk_nvme_ns_cmd_flush()

- spdk_nvme_qpair_process_completions() \copybrief spdk_nvme_qpair_process_completions()

Function                                | Description

--------------------------------------- | -----------

spdk_nvme_probe()                       | \copybrief spdk_nvme_probe()

spdk_nvme_ns_cmd_read()                 | \copybrief spdk_nvme_ns_cmd_read()

spdk_nvme_ns_cmd_write()                | \copybrief spdk_nvme_ns_cmd_write()

spdk_nvme_ns_cmd_deallocate()           | \copybrief spdk_nvme_ns_cmd_deallocate()

spdk_nvme_ns_cmd_flush()                | \copybrief spdk_nvme_ns_cmd_flush()

spdk_nvme_qpair_process_completions()   | \copybrief spdk_nvme_qpair_process_completions()



\section nvme_key_concepts Key Concepts