Commit 1a787169 authored by Daniel Verkamp's avatar Daniel Verkamp Committed by Jim Harris
Browse files

doc: flatten Markdown docs into chapter-per-file 



Doxygen interprets each Markdown input file as a separate section
(chapter).  Concatenate all of the .md files in directories into a
single file per section to get a correctly-nested table of contents.

In particular, this matters for the navigation in the PDF output.

Change-Id: I778849d89da9a308136e43ac6cb630c4c2bbb3a5
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent 388ca483

doc/Doxyfile

+9 −21
Original line number Diff line number Diff line
@@ -784,27 +784,15 @@ INPUT = ../include/spdk \ 
                         index.md \

                         directory_structure.md \

                         porting.md \

                         bdev/index.md \

                         bdev/getting_started.md \

                         blob/index.md \

                         blobfs/index.md \

                         blobfs/getting_started.md \

                         event/index.md \

                         ioat/index.md \

                         iscsi/index.md \

                         iscsi/getting_started.md \

                         iscsi/hotplug.md \

                         nvme/index.md \

                         nvme/async_completion.md \

                         nvme/fabrics.md \

                         nvme/initialization.md \

                         nvme/hotplug.md \

                         nvme/io_submission.md \

                         nvme/multi_process.md \

                         nvmf/index.md \

                         nvmf/getting_started.md \

                         vhost/index.md \

                         vhost/getting_started.md

                         blob.md \

                         blobfs.md \

                         bdev.md \

                         event.md \

                         ioat.md \

                         iscsi.md \

                         nvme.md \

                         nvmf.md \

                         vhost.md



# This tag can be used to specify the character encoding of the source files

# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

doc/bdev/getting_started.md→doc/bdev.md

+2 −0
Original line number Diff line number Diff line 
# Block Device Abstraction Layer {#bdev}



# SPDK bdev Getting Started Guide {#bdev_getting_started}



Block storage in SPDK applications is provided by the SPDK bdev layer.  SPDK bdev consists of:

doc/bdev/index.md

deleted100644 → 0
+0 −3
Original line number Diff line number Diff line 
# Block Device Abstraction Layer {#bdev}



- @ref bdev_getting_started

doc/blob/index.md→doc/blob.md

+0 −0

File moved.

View file

doc/blobfs/getting_started.md→doc/blobfs.md

+2 −0
Original line number Diff line number Diff line 
# BlobFS (Blobstore Filesystem) {#blobfs}



# BlobFS Getting Started Guide {#blobfs_getting_started}



# RocksDB Integration {#blobfs_rocksdb}