d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
cf9e099862
numam-spdk/doc/index.md

51 lines
876 B
Markdown
Raw Normal View History

doc: Convert mainpage to Markdown Convert to markdown. Our other GitHub files are in markdown and doxygen natively supports it, so begin converting the documentation entirely to markdown to minimize the number of formats we have to comprehend. Also rename it to index.md to match the other top level files. Index and mainpage are interchangeable terms in Doxygen. Change-Id: I0f7274b47de6411f8d2d09d987fd1344e01a3986 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-12-28 22:44:35 +00:00
# Storage Performance Development Kit {#index}
# Introduction {#intro}
doc: Reorganize index.md Also fix a few markdown issues. Change-Id: I4e7c95f2a44bb321456f3868e8beb6661c61c26f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392981 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-12-26 19:57:28 +00:00
doc: Add an overview page for the project Change-Id: I21b793c27aa7f24ffa1235c4a2c43d594148a689 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392982 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-12-26 20:22:55 +00:00
- @ref about
doc: Add a getting started guide This closely mirrors what is in README.md, but makes it part of the main doc/ pages. Ultimately, I think README.md should link here to reduce duplicated documentation. Change-Id: I930bada7d7c79d202b8503675511cfb824ec86e2 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/376225 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-08-29 17:40:05 +00:00
- @ref getting_started
doc: Move vagrant documentation to main doc/ page This makes it easier to find from the main landing page. Change-Id: Ic142427cede869c9cbfc6c265c8e4625731f8ce1 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/376232 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-08-29 17:46:49 +00:00
- @ref vagrant
doc: Add a getting started guide This closely mirrors what is in README.md, but makes it part of the main doc/ pages. Ultimately, I think README.md should link here to reduce duplicated documentation. Change-Id: I930bada7d7c79d202b8503675511cfb824ec86e2 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/376225 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-08-29 17:40:05 +00:00
- @ref changelog
- [Source Code (GitHub)](https://github.com/spdk/spdk/)
doc: Convert mainpage to Markdown Convert to markdown. Our other GitHub files are in markdown and doxygen natively supports it, so begin converting the documentation entirely to markdown to minimize the number of formats we have to comprehend. Also rename it to index.md to match the other top level files. Index and mainpage are interchangeable terms in Doxygen. Change-Id: I0f7274b47de6411f8d2d09d987fd1344e01a3986 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-12-28 22:44:35 +00:00
doc: Reorganize index.md Also fix a few markdown issues. Change-Id: I4e7c95f2a44bb321456f3868e8beb6661c61c26f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392981 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-12-26 19:57:28 +00:00
# Concepts {#concepts}
doc: Add an overview of user space drivers This is designed to address some of the more basic questions we often field. Change-Id: I53ead3044abf8add0c912e0ce9721e995ae7a6e7 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392983 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-12-26 21:09:22 +00:00
- @ref userspace
doc: Reorganize index.md Also fix a few markdown issues. Change-Id: I4e7c95f2a44bb321456f3868e8beb6661c61c26f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392981 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-12-26 19:57:28 +00:00
- @ref memory
doc: Attempt to explain I/O channels Attempt, to the best of my ability, to explain I/O devices, threads, I/O channels, asynchronous C programming best practices, and other related concepts. Change-Id: Idd6bdb3a06df71a642b88cdaa7cc37c13655753b Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/393200 Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-12-28 19:46:45 +00:00
- @ref concurrency
doc: Add some documentation about SSD internals Change-Id: I0b215aea443782bdf8ee6772dd2db562597f0d3c Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/394116 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-04-03 20:01:43 +00:00
- @ref ssd_internals
doc: Reorganize index.md Also fix a few markdown issues. Change-Id: I4e7c95f2a44bb321456f3868e8beb6661c61c26f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392981 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-12-26 19:57:28 +00:00
- @ref porting
doc: add a section for user guides Change-Id: I8982bf656adc4fec6990cdd95e5ece71fb0a953b Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-on: https://review.gerrithub.io/379907 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2017-09-25 23:26:56 +00:00
# User Guides {#user_guides}
doc: Remove user guide links from "Modules" section These are duplicate links and they really are user guides, so remove them from the modules section. Change-Id: I0d3bdc235c75f9faa2501984db812dd525cf4fc2 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/397634 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-31 22:05:49 +00:00
- @ref iscsi
- @ref nvmf
doc: Move vhost doc from modules to user guides This is a user guide, so move it to the right spot. Change-Id: I8e50fdb95e6a982b444efd0e0ae55cd4b43e3017 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/397636 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-31 22:11:37 +00:00
- @ref vhost
doc: Move link to bdev layer from modules to user guides This is really a user guide, so move it there. Change-Id: Ia6e26ac82be73a0a40fe41836c987c72ec206ed7 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/397635 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-31 22:08:48 +00:00
- @ref bdev
doc: Remove user guide links from "Modules" section These are duplicate links and they really are user guides, so remove them from the modules section. Change-Id: I0d3bdc235c75f9faa2501984db812dd525cf4fc2 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/397634 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-31 22:05:49 +00:00
- @ref blobfs
doc: Reorganize index.md Also fix a few markdown issues. Change-Id: I4e7c95f2a44bb321456f3868e8beb6661c61c26f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392981 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-12-26 19:57:28 +00:00
- @ref jsonrpc
doc: add a section for user guides Change-Id: I8982bf656adc4fec6990cdd95e5ece71fb0a953b Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-on: https://review.gerrithub.io/379907 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2017-09-25 23:26:56 +00:00
doc: Reorganize index.md Also fix a few markdown issues. Change-Id: I4e7c95f2a44bb321456f3868e8beb6661c61c26f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392981 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-12-26 19:57:28 +00:00
# Programmer Guides {#general}
doc: Convert mainpage to Markdown Convert to markdown. Our other GitHub files are in markdown and doxygen natively supports it, so begin converting the documentation entirely to markdown to minimize the number of formats we have to comprehend. Also rename it to index.md to match the other top level files. Index and mainpage are interchangeable terms in Doxygen. Change-Id: I0f7274b47de6411f8d2d09d987fd1344e01a3986 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-12-28 22:44:35 +00:00
doc: Programming guide for block device abstraction layer Change-Id: Ib27462769e146a2b4b69302eac386255262081f6 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/397286 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Pawel Wodkowski <pawelx.wodkowski@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-03 12:33:45 +00:00
- @ref bdev_pg
- @ref bdev_module
doc: Reorganize index.md Also fix a few markdown issues. Change-Id: I4e7c95f2a44bb321456f3868e8beb6661c61c26f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/392981 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-12-26 19:57:28 +00:00
- @ref directory_structure
- [Public API header files](files.html)
doc: Add the SPDK NVMe-oF Target Programming Guide Add the SPDK NVMe-oF target programming guide based on the most recently implementations of SPDK NVMe-oF library. Change-Id: Idcd5a5ba9a2e4e04392adeb6230d4b18e98dd8e5 Signed-off-by: GangCao <gang.cao@intel.com> Reviewed-on: https://review.gerrithub.io/393631 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: John Kariuki <John.K.Kariuki@intel.com>
2018-01-04 07:32:04 +00:00
- @ref nvmf_tgt_pg
doc: Integrate concurrency and event framework docs Make these two documents link to one another. Also do the following: 1) Make "Event Framework" a Programmer Guide 2) Update some of the text about pollers to reflect recent changes. Change-Id: I3dfbcde0dadcf69b7c165f7bad5bee00d3c10d1f Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/397633 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-31 22:02:07 +00:00
- @ref event
doc: Move blobstore docs from modules to Programmer Guides It's at least the beginning of a Programmer Guide. Change-Id: Ifb0a6a1eefde83ef398f0dc6472c57e9faf4eacc Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/398104 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-31 22:14:12 +00:00
- @ref blob
doc: Convert mainpage to Markdown Convert to markdown. Our other GitHub files are in markdown and doxygen natively supports it, so begin converting the documentation entirely to markdown to minimize the number of formats we have to comprehend. Also rename it to index.md to match the other top level files. Index and mainpage are interchangeable terms in Doxygen. Change-Id: I0f7274b47de6411f8d2d09d987fd1344e01a3986 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-12-28 22:44:35 +00:00
doc: Add a getting started guide This closely mirrors what is in README.md, but makes it part of the main doc/ pages. Ultimately, I think README.md should link here to reduce duplicated documentation. Change-Id: I930bada7d7c79d202b8503675511cfb824ec86e2 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/376225 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-08-29 17:40:05 +00:00
# Modules {#modules}
doc: Convert mainpage to Markdown Convert to markdown. Our other GitHub files are in markdown and doxygen natively supports it, so begin converting the documentation entirely to markdown to minimize the number of formats we have to comprehend. Also rename it to index.md to match the other top level files. Index and mainpage are interchangeable terms in Doxygen. Change-Id: I0f7274b47de6411f8d2d09d987fd1344e01a3986 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-12-28 22:44:35 +00:00
doc: Convert nvme docs to markdown Change-Id: Ifc9c79886f05c6a3abd1553021a65724e53dd5c0 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-01-04 18:35:00 +00:00
- @ref nvme
doc: Convert ioat doc to markdown Change-Id: Ic0f8fa4aa57d6fc58813fcbb6d72ff5477ab293f Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-01-04 21:40:14 +00:00
- @ref ioat
bdev_virtio: added doc page Change-Id: Ia88ae52117068ac395dad9ad3d7ac818e41077fb Signed-off-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-on: https://review.gerrithub.io/380956 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-10-02 17:31:06 +00:00
- @ref virtio
doc:add tools section Change-Id: I6e8a6d636b8d7236a40b7da34722c77677b6cc91 Signed-off-by: prital shah <prital.b.shah@intel.com> Reviewed-on: https://review.gerrithub.io/382374 Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2017-10-13 00:31:12 +00:00
# Tools {#tools}
doc: add the documentation for nvme-cli support Change-Id: Ifd662c6bf6f7d337149c25bb72a9471713db0420 Signed-off-by: GangCao <gang.cao@intel.com> Reviewed-on: https://review.gerrithub.io/369517 Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-07-13 23:08:15 +00:00
- @ref nvme-cli
doc:add Performance report section Change-Id: I3dc7aa70d8a326fb842a2dcbd6a8f9032d98b154 Signed-off-by: prital shah <prital.b.shah@intel.com> Reviewed-on: https://review.gerrithub.io/382375 Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2017-10-13 00:38:31 +00:00
# Performance Reports {#performancereports}
- [SPDK 17.07 vhost-scsi Performance Report](https://ci.spdk.io/download/performance-reports/SPDK17_07_vhost_scsi_performance_report.pdf)
Reference in New Issue Copy Permalink