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>
This commit is contained in:
Jim Harris 2018-06-13 08:00:14 -07:00
parent 64d75fe2a6
commit 11d55d17f7
12 changed files with 84 additions and 52 deletions

View File

@ -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 \

8
doc/concepts.md Normal file
View File

@ -0,0 +1,8 @@
# Concepts {#concepts}
- @subpage userspace
- @subpage memory
- @subpage concurrency
- @subpage ssd_internals
- @subpage vhost_processing
- @subpage porting

View File

@ -0,0 +1,3 @@
# Experimental Tools {#experimental_tools}
- @subpage spdkcli

6
doc/general.md Normal file
View File

@ -0,0 +1,6 @@
# General Information {#general}
- @subpage directory_structure
- [Public API header files](files.html)
- @subpage event
- @subpage logical_volumes

View File

@ -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

7
doc/intro.md Normal file
View File

@ -0,0 +1,7 @@
# Introduction {#intro}
- @subpage about
- @subpage getting_started
- @subpage vagrant
- @subpage changelog
- [Source Code (GitHub)](https://github.com/spdk/spdk)

3
doc/misc.md Normal file
View File

@ -0,0 +1,3 @@
# Miscellaneous {#misc}
- @subpage peer_2_peer

5
doc/modules.md Normal file
View File

@ -0,0 +1,5 @@
# Modules {#modules}
- @subpage nvme
- @subpage ioat
- @subpage virtio

View File

@ -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)

6
doc/prog_guides.md Normal file
View File

@ -0,0 +1,6 @@
# Programmer Guides {#prog_guides}
- @subpage blob
- @subpage bdev_pg
- @subpage bdev_module
- @subpage nvmf_tgt_pg

3
doc/tools.md Normal file
View File

@ -0,0 +1,3 @@
# Tools {#tools}
- @subpage nvme-cli

8
doc/user_guides.md Normal file
View File

@ -0,0 +1,8 @@
# User Guides {#user_guides}
- @subpage iscsi
- @subpage nvmf
- @subpage vhost
- @subpage bdev
- @subpage blobfs
- @subpage jsonrpc