From 11d55d17f755fff95723c8f4da22e0ce5f324e6e Mon Sep 17 00:00:00 2001 From: Jim Harris Date: Wed, 13 Jun 2018 08:00:14 -0700 Subject: [PATCH] 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 Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f Reviewed-on: https://review.gerrithub.io/415085 Tested-by: SPDK Automated Test System Reviewed-by: Daniel Verkamp Reviewed-by: Ben Walker --- doc/Doxyfile | 12 +++++++ doc/concepts.md | 8 +++++ doc/experimental_tools.md | 3 ++ doc/general.md | 6 ++++ doc/index.md | 72 +++++++++++--------------------------- doc/intro.md | 7 ++++ doc/misc.md | 3 ++ doc/modules.md | 5 +++ doc/performance_reports.md | 3 ++ doc/prog_guides.md | 6 ++++ doc/tools.md | 3 ++ doc/user_guides.md | 8 +++++ 12 files changed, 84 insertions(+), 52 deletions(-) create mode 100644 doc/concepts.md create mode 100644 doc/experimental_tools.md create mode 100644 doc/general.md create mode 100644 doc/intro.md create mode 100644 doc/misc.md create mode 100644 doc/modules.md create mode 100644 doc/performance_reports.md create mode 100644 doc/prog_guides.md create mode 100644 doc/tools.md create mode 100644 doc/user_guides.md diff --git a/doc/Doxyfile b/doc/Doxyfile index de3bf61b1..2fd8277ac 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -782,6 +782,18 @@ WARN_LOGFILE = INPUT = ../include/spdk \ index.md \ + \ + intro.md \ + concepts.md \ + user_guides.md \ + prog_guides.md \ + general.md \ + misc.md \ + modules.md \ + tools.md \ + experimental_tools.md \ + performance_reports.md \ + \ about.md \ changelog.md \ concurrency.md \ diff --git a/doc/concepts.md b/doc/concepts.md new file mode 100644 index 000000000..84c91f32e --- /dev/null +++ b/doc/concepts.md @@ -0,0 +1,8 @@ +# Concepts {#concepts} + +- @subpage userspace +- @subpage memory +- @subpage concurrency +- @subpage ssd_internals +- @subpage vhost_processing +- @subpage porting diff --git a/doc/experimental_tools.md b/doc/experimental_tools.md new file mode 100644 index 000000000..970e63e1c --- /dev/null +++ b/doc/experimental_tools.md @@ -0,0 +1,3 @@ +# Experimental Tools {#experimental_tools} + +- @subpage spdkcli diff --git a/doc/general.md b/doc/general.md new file mode 100644 index 000000000..0f87e01a1 --- /dev/null +++ b/doc/general.md @@ -0,0 +1,6 @@ +# General Information {#general} + +- @subpage directory_structure +- [Public API header files](files.html) +- @subpage event +- @subpage logical_volumes diff --git a/doc/index.md b/doc/index.md index 0ebedf4a1..d7a5d6c35 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,63 +1,31 @@ # Storage Performance Development Kit {#index} -# Introduction {#intro} +# Introduction +@copydoc intro -- @ref about -- @ref getting_started -- @ref vagrant -- @ref changelog -- [Source Code (GitHub)](https://github.com/spdk/spdk/) +# Concepts +@copydoc concepts -# Concepts {#concepts} +# User Guides +@copydoc user_guides -- @ref userspace -- @ref memory -- @ref concurrency -- @ref ssd_internals -- @ref vhost_processing -- @ref porting +# Programmer Guides +@copydoc prog_guides -# User Guides {#user_guides} +# General Information +@copydoc general -- @ref iscsi -- @ref nvmf -- @ref vhost -- @ref bdev -- @ref blobfs -- @ref jsonrpc +# Miscellaneous +@copydoc misc -# Programmer Guides {#prog_guides} +# Modules +@copydoc modules -- @ref blob -- @ref bdev_pg -- @ref bdev_module -- @ref nvmf_tgt_pg +# Tools +@copydoc tools -# General Information {#general} +# Experimental Tools +@copydoc experimental_tools -- @ref directory_structure -- [Public API header files](files.html) -- @ref event -- @ref logical_volumes - -# Miscellaneous {#misc} - -- @ref peer_2_peer - -# Modules {#modules} - -- @ref nvme -- @ref ioat -- @ref virtio - -# Tools {#tools} - -- @ref nvme-cli - -# Experimental Tools {#experimental_tools} - -- @ref spdkcli - -# Performance Reports {#performancereports} - -- [SPDK 17.07 vhost-scsi Performance Report](https://ci.spdk.io/download/performance-reports/SPDK17_07_vhost_scsi_performance_report.pdf) +# Performance Reports +@copydoc performance_reports diff --git a/doc/intro.md b/doc/intro.md new file mode 100644 index 000000000..ebae8d454 --- /dev/null +++ b/doc/intro.md @@ -0,0 +1,7 @@ +# Introduction {#intro} + +- @subpage about +- @subpage getting_started +- @subpage vagrant +- @subpage changelog +- [Source Code (GitHub)](https://github.com/spdk/spdk) diff --git a/doc/misc.md b/doc/misc.md new file mode 100644 index 000000000..7eb22354b --- /dev/null +++ b/doc/misc.md @@ -0,0 +1,3 @@ +# Miscellaneous {#misc} + +- @subpage peer_2_peer diff --git a/doc/modules.md b/doc/modules.md new file mode 100644 index 000000000..69a8dc88b --- /dev/null +++ b/doc/modules.md @@ -0,0 +1,5 @@ +# Modules {#modules} + +- @subpage nvme +- @subpage ioat +- @subpage virtio diff --git a/doc/performance_reports.md b/doc/performance_reports.md new file mode 100644 index 000000000..8b3e353be --- /dev/null +++ b/doc/performance_reports.md @@ -0,0 +1,3 @@ +# Performance Reports {#performance_reports} + +- [SPDK 17.07 vhost-scsi Performance Report](https://ci.spdk.io/download/performance-reports/SPDK17_07_vhost_scsi_performance_report.pdf) diff --git a/doc/prog_guides.md b/doc/prog_guides.md new file mode 100644 index 000000000..631c32fdc --- /dev/null +++ b/doc/prog_guides.md @@ -0,0 +1,6 @@ +# Programmer Guides {#prog_guides} + +- @subpage blob +- @subpage bdev_pg +- @subpage bdev_module +- @subpage nvmf_tgt_pg diff --git a/doc/tools.md b/doc/tools.md new file mode 100644 index 000000000..25cd4cdbe --- /dev/null +++ b/doc/tools.md @@ -0,0 +1,3 @@ +# Tools {#tools} + +- @subpage nvme-cli diff --git a/doc/user_guides.md b/doc/user_guides.md new file mode 100644 index 000000000..f0174508e --- /dev/null +++ b/doc/user_guides.md @@ -0,0 +1,8 @@ +# User Guides {#user_guides} + +- @subpage iscsi +- @subpage nvmf +- @subpage vhost +- @subpage bdev +- @subpage blobfs +- @subpage jsonrpc