numam-spdk/doc/index.md

# Storage Performance Development Kit {#mainpage}

# Introduction

@copydoc intro

# Concepts

@copydoc concepts

# User Guides

@copydoc user_guides

# Programmer Guides

@copydoc prog_guides

# General Information

@copydoc general

# Miscellaneous

@copydoc misc

# Driver Modules

@copydoc driver_modules

# Tools

@copydoc tools

# CI Tools

@copydoc ci_tools

# Performance Reports

@copydoc performance_reports
doc: Rename #index label to #mainpage For some reason, newer versions of doxygen started to complain about the following: warning: multiple use of section label 'index' for main page To mitigate, use alternative name for the label. Signed-off-by: Michal Berger <michalx.berger@intel.com> Change-Id: I6387a7c644c6626dd646c9fdd0e9ed1d430881f2 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7132 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Community-CI: Mellanox Build Bot 2021-03-29 14:17:37 +00:00			`# Storage Performance Development Kit {#mainpage}`
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: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# Introduction`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc 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: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# Concepts`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc concepts`
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: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# User Guides`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc user_guides`
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: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# Programmer Guides`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc prog_guides`
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: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# General Information`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc general`
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: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# Miscellaneous`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc misc`
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: change "Modules" page name to "Driver Modules" This eliminates conflict with Doxygen auto-generated "Modules" page. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I571839240405ec0dc952b6a4f7ed65baab4cc42c Reviewed-on: https://review.gerrithub.io/423165 Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-08-22 16:36:34 +00:00			`# Driver Modules`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: change "Modules" page name to "Driver Modules" This eliminates conflict with Doxygen auto-generated "Modules" page. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I571839240405ec0dc952b6a4f7ed65baab4cc42c Reviewed-on: https://review.gerrithub.io/423165 Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-08-22 16:36:34 +00:00			`@copydoc driver_modules`
doc: Programmer's guide template and example for blobstore Includes the proposed Blobstore Programmer's Guide that is also and example for other programming guides as well as a template that can be used to create future programming guides. Also removes the previous blob.md Change-Id: Iefbb58b8c3ab015bf8e0cd02ba2fbe6a86c1852c Signed-off-by: Paul Luse <paul.e.luse@intel.com> Reviewed-on: https://review.gerrithub.io/384118 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-10-27 17:16:03 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# Tools`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc tools`
doc: Programmer's guide template and example for blobstore Includes the proposed Blobstore Programmer's Guide that is also and example for other programming guides as well as a template that can be used to create future programming guides. Also removes the previous blob.md Change-Id: Iefbb58b8c3ab015bf8e0cd02ba2fbe6a86c1852c Signed-off-by: Paul Luse <paul.e.luse@intel.com> Reviewed-on: https://review.gerrithub.io/384118 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-10-27 17:16:03 +00:00
doc: Add "CI Tools" section This section is meant to describe tooling present in the SPDK repo which is used to validate all the submitted patches. Also, add first subpage describing use of shfmt. Change-Id: Ib9d14c8eb28108d6dfdc27e140c008be070a16f5 Signed-off-by: Michal Berger <michalx.berger@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/2455 Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-05-15 10:20:44 +00:00			`# CI Tools`

			`@copydoc ci_tools`

doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`# Performance Reports`
Fix Markdown MD022 linter warnings - headers blank lines MD022 Headers should be surrounded by blank lines Signed-off-by: Karol Latecki <karol.latecki@intel.com> Change-Id: I768324b00fc684c254aff6a85b93d9aed7a0cee5 Signed-off-by: Karol Latecki <karol.latecki@intel.com> Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/656 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-02-07 11:48:26 +00:00
doc: use Doxygen subpages for top-level groupings This results in a much cleaner tree hierarchy in the left navigation pane. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-06-13 15:00:14 +00:00			`@copydoc performance_reports`