Commit 11d55d17 authored by Jim Harris's avatar Jim Harris
Browse files

doc: use Doxygen subpages for top-level groupings 



This results in a much cleaner tree hierarchy in the
left navigation pane.

Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: Ic3c0f8b70398589f9dbc80609c96226c6f3bff8f
Reviewed-on: https://review.gerrithub.io/415085


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 64d75fe2

doc/Doxyfile

+12 −0
Original line number Diff line number Diff line
@@ -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 \

doc/concepts.md

0 → 100644
+8 −0
Original line number Diff line number Diff line 
# Concepts {#concepts}



- @subpage userspace

- @subpage memory

- @subpage concurrency

- @subpage ssd_internals

- @subpage vhost_processing

- @subpage porting

doc/experimental_tools.md

0 → 100644
+3 −0
Original line number Diff line number Diff line 
# Experimental Tools {#experimental_tools}



- @subpage spdkcli

doc/general.md

0 → 100644
+6 −0
Original line number Diff line number Diff line 
# General Information {#general}



- @subpage directory_structure

- [Public API header files](files.html)

- @subpage event

- @subpage logical_volumes

doc/index.md

+20 −52
Original line number Diff line number Diff line 
# 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