doc: move nvmf_tracing.md to tracing.md

This does not need to nvmf specific, tracing is a general concept
that applies to SPDK as a whole. It is still fine to continue using
the nvmf target as the p

doc: move nvmf_tracing.md to tracing.md

This does not need to nvmf specific, tracing is a general concept
that applies to SPDK as a whole. It is still fine to continue using
the nvmf target as the primary example though.

Signed-off-by: Jim Harris <jim.harris@samsung.com>
Change-Id: I72bb92b7a08822366ab1d3db4c6baff26eab389e
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24123
Reviewed-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: GangCao <gang.cao@intel.com>
Community-CI: Community CI Samsung <spdk.community.ci.samsung@gmail.com>

show more ...

doc/Doxyfile: Remove tags marked as deprecated

Change-Id: If11b4d07c20462a8b534038d2ec7965f3b861525
Signed-off-by: Michal Berger <michal.berger@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/

doc/Doxyfile: Remove tags marked as deprecated

Change-Id: If11b4d07c20462a8b534038d2ec7965f3b861525
Signed-off-by: Michal Berger <michal.berger@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/22872
Reviewed-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Reviewed-by: Jim Harris <jim.harris@samsung.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>

show more ...

doc: add a document about FIPS compliance

Change-Id: Ib8a293aed5e5acc770211f28fc785266ff218ecc
Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c

doc: add a document about FIPS compliance

Change-Id: Ib8a293aed5e5acc770211f28fc785266ff218ecc
Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/20697
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com>

show more ...

doc: Add a page about backporting and updating submodules.

Add a new documentation entry to cover backporting
to older, supported branches and instructions how
to update a submodule.

Change-Id: I27

doc: Add a page about backporting and updating submodules.

Add a new documentation entry to cover backporting
to older, supported branches and instructions how
to update a submodule.

Change-Id: I2797843699e6f06affac2fc940ce4b792d266082
Signed-off-by: Krzysztof Karas <krzysztof.karas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/19391
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Jim Harris <jim.harris@samsung.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>

show more ...

deprecation: add the md to documentation Makefile

Originally deprecation.md was pulled verbatim to
the built documentation. This resulted in very
weird paths on the spdk.io:
https://spdk.io/doc/md__

deprecation: add the md to documentation Makefile

Originally deprecation.md was pulled verbatim to
the built documentation. This resulted in very
weird paths on the spdk.io:
https://spdk.io/doc/md__home_sys_sgsw_oss_spdk_github_io_spdk_deprecation.html#deprecation

Use the way that changelog does it, by copying
the file and adding appropriate section links.

Now only the Doxygen version will contain the
section links. Meanwhile deprecation.md in
project root will not. This improves readability.

Change-Id: Ic5c1caf7603b847b3c7445bde76e277ba1ccb740
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16574
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>

show more ...

doc: describe ublk target in user guide

Signed-off-by: Liu Xiaodong <xiaodong.liu@intel.com>
Change-Id: I0de47e21a34d7766c4addd6f751098b03d8a4a9e
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/sp

doc: describe ublk target in user guide

Signed-off-by: Liu Xiaodong <xiaodong.liu@intel.com>
Change-Id: I0de47e21a34d7766c4addd6f751098b03d8a4a9e
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16245
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>

show more ...

doc/Doxyfile: remove obsolete options with the default values

Options:
FORMULA_TRANSPARENT
LATEX_SOURCE_CODE
RTF_SOURCE_CODE
DOCBOOK_PROGRAMLISTING
CLASS_DIAGRAMS
DOT_FONTNAME
DOT_FONTSIZE
DOT_TRANS

doc/Doxyfile: remove obsolete options with the default values

Options:
FORMULA_TRANSPARENT
LATEX_SOURCE_CODE
RTF_SOURCE_CODE
DOCBOOK_PROGRAMLISTING
CLASS_DIAGRAMS
DOT_FONTNAME
DOT_FONTSIZE
DOT_TRANSPARENT

are obsolete in the Doxygen version 1.9.5
Doxyfile has been updated with 'doxygen -u'

Signed-off-by: Kamil Godzwon <kamilx.godzwon@intel.com>
Change-Id: Ic2c598f2e463d94b963a32a20f28a16b21389bfe
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15822
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Michal Berger <michal.berger@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Karol Latecki <karol.latecki@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>

show more ...

doc/nvmf: nvmf multipath documentation

Signed-off-by: Theo Jepsen <theo.jepsen@intel.com>
Change-Id: Iff7d6e3aaf3c078647f70a9a63584e12cd8356ea
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/

doc/nvmf: nvmf multipath documentation

Signed-off-by: Theo Jepsen <theo.jepsen@intel.com>
Change-Id: Iff7d6e3aaf3c078647f70a9a63584e12cd8356ea
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/14042
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: John Kariuki <John.K.Kariuki@intel.com>
Reviewed-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>

show more ...

doc: describe storage management agent

Signed-off-by: Konrad Sztyber <konrad.sztyber@intel.com>
Change-Id: Ibe602571413531f151136a68ad4bdcd0a6be32e9
Reviewed-on: https://review.spdk.io/gerrit/c/spdk

doc: describe storage management agent

Signed-off-by: Konrad Sztyber <konrad.sztyber@intel.com>
Change-Id: Ibe602571413531f151136a68ad4bdcd0a6be32e9
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12117
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>

show more ...

doc: Multipath document

Add an independent document for NVMe multipath. Then link it from
user_guide.md and bdev.md.

Signed-off-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Change-Id: I6035a3c73727

doc: Multipath document

Add an independent document for NVMe multipath. Then link it from
user_guide.md and bdev.md.

Signed-off-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
Change-Id: I6035a3c73727b4140d2a78fb10a1e6f94c0bdaa3
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12297
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: GangCao <gang.cao@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>

show more ...

doc/doxyfile: remove timestamps generation

Doc files should be updated only if the file
content (actual documentation) will change.

Doxygen adds timestamps to the footer
of every doc file in spdk/d

doc/doxyfile: remove timestamps generation

Doc files should be updated only if the file
content (actual documentation) will change.

Doxygen adds timestamps to the footer
of every doc file in spdk/doc directory.
Every day, when the date is changed,
all pages get a new date and it triggers
automatic commits push for all >500 doc pages
with a new date in the footer.

This change removes automatically generated
timestamps for each spdk/doc file footer.
In fact, these timestamps are not visible
directly on the page running in the browser anyway.

Signed-off-by: Kamil Godzwon <kamilx.godzwon@intel.com>
Change-Id: I6039a250613f109e255fd61a55ba9e3b197e7b10
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12326
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>

show more ...

doc: do not document void returns

This patch enables WARN_NO_PARAMDOC in Doxygen and
resolves remaining issues.

Void return type does not require documentation.
Some of the removed docs were not ev

doc: do not document void returns

This patch enables WARN_NO_PARAMDOC in Doxygen and
resolves remaining issues.

Void return type does not require documentation.
Some of the removed docs were not even Doxygen type
comment, see lack of '\'.

Fixed errors were similar to below:
spdk/include/spdk/nvmf.h:1081: warning: documented empty return type of spdk_nvmf_tgt_add_transport

Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I6bb282ead8dc918885f7a89ab8829e4f5c477247
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10387
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>

show more ...

spelling: doc

Part of #2256

* accessible
* bstatic
* example
* initiator
* obvious
* privileged
* scenario
* transparent

Change-Id: I15f30f56e3bb18443c829830454360945878012a
Signed-off-by: Josh So

spelling: doc

Part of #2256

* accessible
* bstatic
* example
* initiator
* obvious
* privileged
* scenario
* transparent

Change-Id: I15f30f56e3bb18443c829830454360945878012a
Signed-off-by: Josh Soref <jsoref@gmail.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10401
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>

show more ...

doc: Add page describing OS distros used by the CI

Signed-off-by: Michal Berger <michalx.berger@intel.com>
Change-Id: I9efbb1928e1935ec55edbdb23a6ad99772b1e6ae
Reviewed-on: https://review.spdk.io/ge

doc: Add page describing OS distros used by the CI

Signed-off-by: Michal Berger <michalx.berger@intel.com>
Change-Id: I9efbb1928e1935ec55edbdb23a6ad99772b1e6ae
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9522
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Karol Latecki <karol.latecki@intel.com>

show more ...

doc: add a page for USDT

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I5aa5ec3c3fc695a2555a34ac4e119e256da464a5
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7195
Teste

doc: add a page for USDT

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I5aa5ec3c3fc695a2555a34ac4e119e256da464a5
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7195
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>

show more ...

deprecation: add a file to gather all deprecation notices

Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I66e442c4d10c1d40f4d9240f4f48374fc6966f29
Reviewed-on: https://review.

deprecation: add a file to gather all deprecation notices

Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I66e442c4d10c1d40f4d9240f4f48374fc6966f29
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6591
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: <dongx.yi@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot

show more ...

doc: Add doc about building RPMs

Signed-off-by: Michal Berger <michalx.berger@intel.com>
Change-Id: I78c6a1f376a317bd88298f9d19034848790aa667
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+

doc: Add doc about building RPMs

Signed-off-by: Michal Berger <michalx.berger@intel.com>
Change-Id: I78c6a1f376a317bd88298f9d19034848790aa667
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7266
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot

show more ...

doc: Disable doxygen options marked as obsolete in newer versions

Next step would be to upgrade the entire Doxyfile to meet the new
specs. For now, prevent doxygen from generating warnings about
th

doc: Disable doxygen options marked as obsolete in newer versions

Next step would be to upgrade the entire Doxyfile to meet the new
specs. For now, prevent doxygen from generating warnings about
these opts.

Signed-off-by: Michal Berger <michalx.berger@intel.com>
Change-Id: I2761675a435beb49abede89bc520c12a2cdc2dff
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7134
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

show more ...

doc: Stop generating latex docs

We only publish them as HTML

Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Change-Id: I88daf01556271bf87e5bff45608fb068523cb0c2
Reviewed-on: https://review.s

doc: Stop generating latex docs

We only publish them as HTML

Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Change-Id: I88daf01556271bf87e5bff45608fb068523cb0c2
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6452
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>

show more ...

doc: added scheduler framework documentation

Added changelog entry for dynamic scheduler, along with general
information on scheduler framework and behaviour of particular
scheduler implemenations.

doc: added scheduler framework documentation

Added changelog entry for dynamic scheduler, along with general
information on scheduler framework and behaviour of particular
scheduler implemenations.

Change-Id: I9fcef56323c4be136b6b531297b070562981eee5
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6151
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>

show more ...

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 spd

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>

show more ...

test: remove spdk/nvme-cli references

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: I8b7777a89491b45ba785629679a34e0aa22f7e61
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/s

test: remove spdk/nvme-cli references

Signed-off-by: Maciej Wawryk <maciejx.wawryk@intel.com>
Change-Id: I8b7777a89491b45ba785629679a34e0aa22f7e61
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5543
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Karol Latecki <karol.latecki@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>

show more ...

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.

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>

show more ...

doc/spdk_top: add spdk_top documentation

Add documentation for the new spdk_top application

Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363
Signed-off-by: John Kariuki <John.K.Kariuki@intel.co

doc/spdk_top: add spdk_top documentation

Add documentation for the new spdk_top application

Change-Id: I49a2ab3b354a1da6583f1b2aea4901cb38dd2363
Signed-off-by: John Kariuki <John.K.Kariuki@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3254
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>

show more ...

doc/vpp: remove VPP documentation

Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I9f506b415fc0f4b1b102f5c04fbb4d3a1fd9dd5d
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/sp

doc/vpp: remove VPP documentation

Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I9f506b415fc0f4b1b102f5c04fbb4d3a1fd9dd5d
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/3733
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: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>

show more ...