numam-spdk/doc/prog_guides.md

# Programmer Guides {#prog_guides}

- [Public API header files](files.html)
- @subpage blob
- @subpage bdev_pg
- @subpage bdev_module
- @subpage nvmf_tgt_pg
- @subpage ftl
- @subpage gdb_macros
- @subpage reduce
- @subpage notify
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 08:00:14 -07:00			`# Programmer Guides {#prog_guides}`

doc: Move link to API headers to Programmer Guides section This is an important link for programmers. Change-Id: Iae89da531b98f9e0fdadd7564de0f165cc96e2b8 Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/421552 Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com> 2018-08-07 14:44:34 -07:00			`- [Public API header files](files.html)`
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 08:00:14 -07:00			`- @subpage blob`
			`- @subpage bdev_pg`
			`- @subpage bdev_module`
			`- @subpage nvmf_tgt_pg`
ftl: Initial headers This patch introduces core structures required for implementing FTL on top of Open Channel drives. The Open Channel specification describes raw access to the media on the SSD. The FTL consumes that API and exposes a block device interface. The implementation is based on the revision 2.0 of the Open Channel SSD specification. Change-Id: Ie306cdfb7920df3b02233fcb60896745f3184cdc Signed-off-by: Wojciech Malikowski <wojciech.malikowski@intel.com> Signed-off-by: Konrad Sztyber <konrad.sztyber@intel.com> Reviewed-on: https://review.gerrithub.io/c/431321 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> Reviewed-by: Jim Harris <james.r.harris@intel.com> 2018-10-29 07:29:03 -04:00			`- @subpage ftl`
doc: add documentation for gdb_macros Change-Id: Iec5569c6b8dbca743ed007170f71bec61320ac78 Signed-off-by: shahar salzman <shahar.salzman@kaminario.com> Reviewed-on: https://review.gerrithub.io/c/442714 Reviewed-by: Pawel Kaminski <pawelx.kaminski@intel.com> Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> 2019-01-30 11:53:42 +02:00			`- @subpage gdb_macros`
compression: added docs and changelog info on reduce/compression bdev Change-Id: Ib4bd9759bb97080b5ccc560580ac4519f105c8a6 Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/452652 Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> 2019-04-30 11:45:12 -04:00			`- @subpage reduce`
doc/notify: add missing links about notify Change-Id: I3848d0e5e9699ff345a65c490253237b4ea3af83 Signed-off-by: wuzhouhui <wuzhouhui@kingsoft.com> Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/453152 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> 2019-05-05 19:52:59 +08:00			`- @subpage notify`