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

43 lines
821 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 15:44:35 -07:00
# Storage Performance Development Kit {#index}
# Introduction {#intro}
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 10:40:05 -07: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 10:46:49 -07: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 10:40:05 -07: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 15:44:35 -07:00
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 16:26:56 -07:00
# User Guides {#user_guides}
- @ref iscsi_getting_started
- @ref nvmf_getting_started
- @ref blobfs_getting_started
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 10:40:05 -07:00
# General Information {#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 15:44:35 -07:00
doc: Convert directory structure to markdown Change-Id: I3af62591658ccd2ae664d73ab5a680a9725469e7 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-12-28 16:02:11 -07:00
- @ref directory_structure
Add documentation explaining memory management Change-Id: Ifce9507fc327ee090d4a825323df928d440fe025 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/362273 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>
2017-03-31 13:49:15 -07:00
- @ref memory
doc: move porting guide into doc/ and add to index This moves all the documentation under the doc/ tree for consistency. Replace the link to include/spdk/env.h to raw text - the Doxygen Markdown parser will automatically turn it into a link since it is a Doxygen input file. Change-Id: If6bde1cfc965cada2c741acd5505026545ad4cf7 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-17 16:23:28 -07:00
- @ref porting
doc: link to Doxygen's file list from main page Change-Id: I703732d28b73d03fd0d43017cd262af4a2d666c2 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-17 17:39:01 -07:00
- [Public API header files](files.html)
doc: add JSON-RPC docs for nvmf_tgt methods This is a first pass at adding documentation for JSON-RPC methods. Currently, this covers the following nvmf_tgt RPC methods: - get_nvmf_subsystems - construct_nvmf_subsystem - delete_nvmf_subsystem Change-Id: I51f74eed52e68fef8307a278b2e36c326689bf92 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-on: https://review.gerrithub.io/381559 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
2017-08-30 13:02:29 -07:00
- @ref jsonrpc
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 15:44:35 -07: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 10:40:05 -07: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 15:44:35 -07:00
event: move component descriptions to doc/ and rewrite Change-Id: I53b061933319204f9153423fa18532712676287a Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-01-26 16:10:25 -07:00
- @ref event
doc: Convert nvme docs to markdown Change-Id: Ifc9c79886f05c6a3abd1553021a65724e53dd5c0 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-01-04 11:35:00 -07:00
- @ref nvme
doc: Convert nvmf doc to markdown Change-Id: I1a1c8570f4b2b2cd6074a4bdd6102751f6239715 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-01-04 14:47:02 -07:00
- @ref nvmf
doc: Convert ioat doc to markdown Change-Id: Ic0f8fa4aa57d6fc58813fcbb6d72ff5477ab293f Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-01-04 14:40:14 -07:00
- @ref ioat
doc: Convert iscsi doc to markdown Change-Id: I70da378361bd82da7b42f4ad5a5560baf70361f2 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-01-04 14:53:20 -07:00
- @ref iscsi
bdev: add a getting started guide For now, this contains the documentation for configuring block devices in configuration files. This file can then be used a common reference for other getting started guides - iscsi, vhost and nvmf targets. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ie6f6c0b3f36dd3fdf418b904462c81a1696b9694
2017-03-15 14:47:17 -07:00
- @ref bdev
blob: Add a design document This outlines the basic concepts in the blobstore. Change-Id: Ib44c3bd5c04ddb0cc06eeb0e50ae6ff1bdf94dd5 Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2017-03-20 14:21:12 -07:00
- @ref blob
blobfs: Add a lightweight filesystem built on the blobstore This is the initial commit for "blobfs", a lightweight filesystem built on top of the SPDK blobstore. Also included in this patch: 1) a shim for using SPDK bdevs as the backing store for SPDK blobstore/blobfs 2) documentation for using blobfs as the storage engine with RocksDB 3) scripts for running a set of workloads and collecting profiling data with RocksDB and blobfs See doc/blobfs/getting_started.md included in this commit for more details on blobfs, including some of the current limitations. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I2a6d3d4b87236730051228ed62c0c04e04c42c73
2017-03-22 13:35:00 -07:00
- @ref blobfs
vhost: Getting Started for SPDK vhost This patch adds getting started guide for SPDK vhost. This document describes how to build and run vhost application. Signed-off-by: Piotr Pelplinski <piotr.pelplinski@intel.com> Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Change-Id: Icab3ad75f1ebf4d53153fb7070151a7244f1dfa9
2017-03-23 09:28:21 +01:00
- @ref vhost
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 19:31:06 +02: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-12 17:31:12 -07: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 19:08:15 -04: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-12 17:38:31 -07: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