numam-spdk/doc/user_guides.md

# User Guides {#user_guides}

- @subpage system_configuration
- @subpage libraries
- @subpage pkgconfig
- @subpage app_overview
- @subpage iscsi
- @subpage nvmf
- @subpage vhost
- @subpage bdev
- @subpage blobfs
- @subpage jsonrpc
- @subpage jsonrpc_proxy
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 {#user_guides}`

Doc: Clarify the IOMMU configuration for User Space Drivers In the case system charges PCI devices with the "uio_pci_generic" kernel driver, the IOMMU should be disabled or passthrough, because the virtual / physical address conversion by IOMMU will make the DMA transmission invalid. The patch guides users configure IOMMU in SPDK target system on both x86_64 and arm64 systems. Change-Id: I66df4df855a6669d4838eb88bd400ded87d08a49 Signed-off-by: tone.zhang <tone.zhang@arm.com> Reviewed-on: https://review.gerrithub.io/424470 Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> 2018-09-04 05:56:58 +00:00			`- @subpage system_configuration`
doc: add library documentation. This user guide details the SPDK library structure, naming and versioning conventions, and instructions for use. Signed-off-by: Seth Howell <seth.howell@intel.com> Change-Id: I1a7ec422730ba169662de76847c77b9433cc3b04 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/2404 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Community-CI: Mellanox Build Bot 2020-05-13 04:30:20 +00:00			`- @subpage libraries`
build: generate pkg-config files for SPDK Users can now generate the necessary linker args for their own applications using something like: PKG_CONFIG_PATH=build/lib/pkgconfig pkg-config --libs spdk_nvme Dependencies between libraries are included in the generated .pc files, so the user only needs to pass the top-level subsystems or individual SPDK libraries they are using in their application. Modules will automatically be added to the output if the associated library is specified. For example, specifying "spdk_bdev" will include the libraries not only for spdk_bdev, but also all of the bdev modules. Users still need to supply the -Wl,--no-as-needed or -Wl,--whole-archive flags. They cannot be added to the .pc files without increasing the length of the argument string by a factor of 15x to 20x. Modify the test/external_code/hello_world Makefile to use pkg-config to ensure this gets tested at some level in our autotest environment. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ie48a75f11969d5d775d514cf10bcb82d197eabfd Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4371 Community-CI: Broadcom CI Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2020-09-24 00:06:02 +00:00			`- @subpage pkgconfig`
doc: Make the application command page an application overview Add a brief section outlining what applications are available. Also word-wrap and do some minor grammar corrections on the rest of the text in the document. Change-Id: I4a3064e7a47e09a28a7b998955768f54a8a9cf9a Signed-off-by: Ben Walker <benjamin.walker@intel.com> Reviewed-on: https://review.gerrithub.io/421551 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com> 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> 2018-08-07 21:40:54 +00:00			`- @subpage app_overview`
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			`- @subpage iscsi`
			`- @subpage nvmf`
			`- @subpage vhost`
			`- @subpage bdev`
			`- @subpage blobfs`
			`- @subpage jsonrpc`
doc: add remote RPC access description Signed-off-by: Maciej Szwed <maciej.szwed@intel.com> Change-Id: I7dfd9ab4826583c6287b0270ecb919d59722c371 Reviewed-on: https://review.gerrithub.io/428007 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> 2018-10-04 10:56:36 +00:00			`- @subpage jsonrpc_proxy`