Changes in Doxyfile

2f2acf4eb25cee406c156120cee22721275ca7fd - doc: move nvmf_tracing.md to tracing.md

Wed, 10 Jul 2024 19:57:38 +0000

doc: move nvmf_tracing.md to tracing.mdThis does not need to nvmf specific, tracing is a general conceptthat applies to SPDK as a whole. It is still fine to continue usingthe nvmf target as the primary example though.Signed-off-by: Jim Harris Change-Id: I72bb92b7a08822366ab1d3db4c6baff26eab389eReviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24123Reviewed-by: Shuhei Matsumoto Tested-by: SPDK CI Jenkins Reviewed-by: Aleksey Marchuk Reviewed-by: GangCao Community-CI: Community CI Samsung List of files: /spdk/doc/Doxyfile

588e20ee1a6a770920a105a40b87d3861e2285c9 - doc/Doxyfile: Remove tags marked as deprecated

Tue, 23 Apr 2024 14:20:20 +0000

doc/Doxyfile: Remove tags marked as deprecatedChange-Id: If11b4d07c20462a8b534038d2ec7965f3b861525Signed-off-by: Michal Berger Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/22872Reviewed-by: Shuhei Matsumoto Reviewed-by: Jim Harris Tested-by: SPDK CI Jenkins List of files: /spdk/doc/Doxyfile

0530a8be35c838bfac1c6de7faee40f00d37afc1 - doc: add a document about FIPS compliance

Fri, 24 Nov 2023 08:56:34 +0000

doc: add a document about FIPS complianceChange-Id: Ib8a293aed5e5acc770211f28fc785266ff218eccSigned-off-by: Krzysztof Karas Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/20697Reviewed-by: Tomasz Zawadzki Tested-by: SPDK CI Jenkins Reviewed-by: Aleksey Marchuk List of files: /spdk/doc/Doxyfile

695631972fedfe6b838827ba4c90b52a8432635d - doc: Add a page about backporting and updating submodules.

Tue, 08 Aug 2023 11:29:20 +0000

doc: Add a page about backporting and updating submodules.Add a new documentation entry to cover backportingto older, supported branches and instructions howto update a submodule.Change-Id: I2797843699e6f06affac2fc940ce4b792d266082Signed-off-by: Krzysztof Karas Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/19391Reviewed-by: Tomasz Zawadzki Reviewed-by: Jim Harris Tested-by: SPDK CI Jenkins List of files: /spdk/doc/Doxyfile

66e0ed8e8d5c75ca4ef456c10a394c2896895a35 - deprecation: add the md to documentation Makefile

Fri, 27 Jan 2023 09:11:02 +0000

deprecation: add the md to documentation MakefileOriginally deprecation.md was pulled verbatim tothe built documentation. This resulted in veryweird paths on the spdk.io:https://spdk.io/doc/md__home_sys_sgsw_oss_spdk_github_io_spdk_deprecation.html#deprecationUse the way that changelog does it, by copyingthe file and adding appropriate section links.Now only the Doxygen version will contain thesection links. Meanwhile deprecation.md inproject root will not. This improves readability.Change-Id: Ic5c1caf7603b847b3c7445bde76e277ba1ccb740Signed-off-by: Tomasz Zawadzki Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16574Reviewed-by: Jim Harris Tested-by: SPDK CI Jenkins Reviewed-by: Ben Walker List of files: /spdk/doc/Doxyfile

651c558d0e3dabe7dd4770acc442666f1a933432 - doc: describe ublk target in user guide

Wed, 11 Jan 2023 09:26:10 +0000

doc: describe ublk target in user guideSigned-off-by: Liu Xiaodong Change-Id: I0de47e21a34d7766c4addd6f751098b03d8a4a9eReviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16245Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Tomasz Zawadzki List of files: /spdk/doc/Doxyfile

a043e45cd1ab63d90e283d8597e4a3606bcdc0f2 - doc/Doxyfile: remove obsolete options with the default values

Wed, 07 Dec 2022 13:54:32 +0000

doc/Doxyfile: remove obsolete options with the default valuesOptions:FORMULA_TRANSPARENTLATEX_SOURCE_CODERTF_SOURCE_CODEDOCBOOK_PROGRAMLISTINGCLASS_DIAGRAMSDOT_FONTNAMEDOT_FONTSIZEDOT_TRANSPARENTare obsolete in the Doxygen version 1.9.5Doxyfile has been updated with 'doxygen -u'Signed-off-by: Kamil Godzwon Change-Id: Ic2c598f2e463d94b963a32a20f28a16b21389bfeReviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/15822Tested-by: SPDK CI Jenkins Reviewed-by: Michal Berger Reviewed-by: Tomasz Zawadzki Reviewed-by: Karol Latecki Reviewed-by: Jim Harris List of files: /spdk/doc/Doxyfile

e745bb654c7393060ee945fcf49ceb9ab47b2b10 - doc/nvmf: nvmf multipath documentation

Wed, 24 Aug 2022 20:52:20 +0000

doc/nvmf: nvmf multipath documentationSigned-off-by: Theo Jepsen Change-Id: Iff7d6e3aaf3c078647f70a9a63584e12cd8356eaReviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/14042Reviewed-by: Ben Walker Reviewed-by: John Kariuki Reviewed-by: Shuhei Matsumoto Tested-by: SPDK CI Jenkins List of files: /spdk/doc/Doxyfile

79a3ac886328a1f29c865b872f3469b508b31192 - doc: describe storage management agent

Thu, 31 Mar 2022 16:50:02 +0000

doc: describe storage management agentSigned-off-by: Konrad Sztyber Change-Id: Ibe602571413531f151136a68ad4bdcd0a6be32e9Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12117Community-CI: Broadcom CI Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Tomasz Zawadzki List of files: /spdk/doc/Doxyfile

b0ab552452782d89f79cb3a1b4a89bd6e8d6fdbb - doc: Multipath document

Fri, 29 Apr 2022 05:38:18 +0000

doc: Multipath documentAdd an independent document for NVMe multipath. Then link it fromuser_guide.md and bdev.md.Signed-off-by: Shuhei Matsumoto Change-Id: I6035a3c73727b4140d2a78fb10a1e6f94c0bdaa3Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12297Community-CI: Broadcom CI Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: GangCao Reviewed-by: Ben Walker List of files: /spdk/doc/Doxyfile

164ab112ab1336767d7ea5fc2a6cf70e73f8d9a7 - doc/doxyfile: remove timestamps generation

Thu, 21 Apr 2022 11:16:16 +0000

doc/doxyfile: remove timestamps generationDoc files should be updated only if the filecontent (actual documentation) will change.Doxygen adds timestamps to the footerof every doc file in spdk/doc directory.Every day, when the date is changed,all pages get a new date and it triggersautomatic commits push for all >500 doc pageswith a new date in the footer.This change removes automatically generatedtimestamps for each spdk/doc file footer.In fact, these timestamps are not visibledirectly on the page running in the browser anyway.Signed-off-by: Kamil Godzwon Change-Id: I6039a250613f109e255fd61a55ba9e3b197e7b10Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12326Reviewed-by: Konrad Sztyber Reviewed-by: Tomasz Zawadzki Tested-by: SPDK CI Jenkins List of files: /spdk/doc/Doxyfile

9e3ed3638d457cf6e4130f5013179b89e2c9a6c9 - doc: do not document void returns

Wed, 24 Nov 2021 09:37:07 +0000

doc: do not document void returnsThis patch enables WARN_NO_PARAMDOC in Doxygen andresolves remaining issues.Void return type does not require documentation.Some of the removed docs were not even Doxygen typecomment, 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_transportSigned-off-by: Tomasz Zawadzki Change-Id: I6bb282ead8dc918885f7a89ab8829e4f5c477247Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10387Tested-by: SPDK CI Jenkins Community-CI: Broadcom CI Reviewed-by: Dong Yi Reviewed-by: Shuhei Matsumoto Reviewed-by: Jim Harris Reviewed-by: Aleksey Marchuk List of files: /spdk/doc/Doxyfile

a82b365b90fca7681cb84de66f00c8a090ee45b7 - spelling: doc

Thu, 25 Nov 2021 01:40:57 +0000

spelling: docPart of #2256* accessible* bstatic* example* initiator* obvious* privileged* scenario* transparentChange-Id: I15f30f56e3bb18443c829830454360945878012aSigned-off-by: Josh Soref Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10401Community-CI: Broadcom CI Tested-by: SPDK CI Jenkins Reviewed-by: Shuhei Matsumoto Reviewed-by: Tomasz Zawadzki List of files: /spdk/doc/Doxyfile

91a4e9160a8c5412a14d5f029b5229c10a70f141 - doc: Add page describing OS distros used by the CI

Thu, 16 Sep 2021 08:01:42 +0000

doc: Add page describing OS distros used by the CISigned-off-by: Michal Berger Change-Id: I9efbb1928e1935ec55edbdb23a6ad99772b1e6aeReviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9522Community-CI: Broadcom CI Tested-by: SPDK CI Jenkins Reviewed-by: Tomasz Zawadzki Reviewed-by: Ben Walker Reviewed-by: Karol Latecki List of files: /spdk/doc/Doxyfile

e0c9c640c69926cea25c82321459e947adf53ff6 - doc: add a page for USDT

Thu, 01 Apr 2021 00:52:42 +0000

doc: add a page for USDTSigned-off-by: Jim Harris Change-Id: I5aa5ec3c3fc695a2555a34ac4e119e256da464a5Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7195Tested-by: SPDK CI Jenkins Reviewed-by: Changpeng Liu Reviewed-by: Shuhei Matsumoto Reviewed-by: Konrad Sztyber Reviewed-by: Paul Luse List of files: /spdk/doc/Doxyfile

9a3877213e9c26ace942f932fc6e23a4d3fe366e - deprecation: add a file to gather all deprecation notices

Fri, 26 Feb 2021 12:33:12 +0000

deprecation: add a file to gather all deprecation noticesSigned-off-by: Tomasz Zawadzki Change-Id: I66e442c4d10c1d40f4d9240f4f48374fc6966f29Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6591Reviewed-by: Jim Harris Reviewed-by: Ben Walker Reviewed-by: Tested-by: SPDK CI Jenkins Community-CI: Mellanox Build Bot List of files: /spdk/doc/Doxyfile

dc672e78a042b65fdb52aed18ed10d89968c5e48 - doc: Add doc about building RPMs

Wed, 07 Apr 2021 08:59:47 +0000

doc: Add doc about building RPMsSigned-off-by: Michal Berger Change-Id: I78c6a1f376a317bd88298f9d19034848790aa667Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7266Reviewed-by: Jim Harris Reviewed-by: Tomasz Zawadzki Tested-by: SPDK CI Jenkins Community-CI: Mellanox Build Bot List of files: /spdk/doc/Doxyfile

20244a18b80e6e4a38756c8b3211a0332aa80d22 - doc: Disable doxygen options marked as obsolete in newer versions

Mon, 29 Mar 2021 16:10:52 +0000

doc: Disable doxygen options marked as obsolete in newer versionsNext step would be to upgrade the entire Doxyfile to meet the newspecs. For now, prevent doxygen from generating warnings aboutthese opts.Signed-off-by: Michal Berger Change-Id: I2761675a435beb49abede89bc520c12a2cdc2dffReviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7134Tested-by: SPDK CI Jenkins Reviewed-by: Tomasz Zawadzki Reviewed-by: Jim Harris Community-CI: Mellanox Build Bot List of files: /spdk/doc/Doxyfile

1d8861e58f7330d3ba63daab29d4697bed096cdb - doc: Stop generating latex docs

Wed, 09 Sep 2020 14:53:56 +0000

doc: Stop generating latex docsWe only publish them as HTMLSigned-off-by: Ben Walker Change-Id: I88daf01556271bf87e5bff45608fb068523cb0c2Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6452Tested-by: SPDK CI Jenkins Community-CI: Mellanox Build BotReviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto List of files: /spdk/doc/Doxyfile

c15af452f6d2a8239e051baabaa0749ac670f21b - doc: added scheduler framework documentation

Thu, 28 Jan 2021 14:54:56 +0000

doc: added scheduler framework documentationAdded changelog entry for dynamic scheduler, along with generalinformation on scheduler framework and behaviour of particularscheduler implemenations.Change-Id: I9fcef56323c4be136b6b531297b070562981eee5Signed-off-by: Tomasz Zawadzki Signed-off-by: Ben Walker Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6151Reviewed-by: Jim Harris Tested-by: SPDK CI Jenkins List of files: /spdk/doc/Doxyfile