From 68f9bbc71904b4fadf2e1fed73c55548a94f3309 Mon Sep 17 00:00:00 2001 From: Ben Walker Date: Mon, 6 May 2019 10:29:35 -0700 Subject: [PATCH] doc: Rename directory_structure.md to overview.md Change title, move to Concepts section. Otherwise the document remains the same. Change-Id: I15dfe541447a620e270d94df32c76b36082ef4be Signed-off-by: Ben Walker Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/453451 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Shuhei Matsumoto --- doc/Doxyfile | 2 +- doc/concepts.md | 1 + doc/general.md | 1 - doc/{directory_structure.md => overview.md} | 2 +- doc/ssd_internals.md | 2 +- 5 files changed, 4 insertions(+), 4 deletions(-) rename doc/{directory_structure.md => overview.md} (99%) diff --git a/doc/Doxyfile b/doc/Doxyfile index 8e380c169..1a61fbe02 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -810,7 +810,6 @@ INPUT += \ changelog.md \ compression.md \ concurrency.md \ - directory_structure.md \ event.md \ ftl.md \ gdb_macros.md \ @@ -827,6 +826,7 @@ INPUT += \ nvmf.md \ nvmf_tgt_pg.md \ nvmf_tracing.md \ + overview.md \ peer_2_peer.md \ porting.md \ spdkcli.md \ diff --git a/doc/concepts.md b/doc/concepts.md index 84c91f32e..11019a485 100644 --- a/doc/concepts.md +++ b/doc/concepts.md @@ -5,4 +5,5 @@ - @subpage concurrency - @subpage ssd_internals - @subpage vhost_processing +- @subpage overview - @subpage porting diff --git a/doc/general.md b/doc/general.md index ac16dc409..4b61540a6 100644 --- a/doc/general.md +++ b/doc/general.md @@ -1,6 +1,5 @@ # General Information {#general} -- @subpage directory_structure - @subpage event - @subpage logical_volumes - @subpage vpp_integration diff --git a/doc/directory_structure.md b/doc/overview.md similarity index 99% rename from doc/directory_structure.md rename to doc/overview.md index 559f3a59e..42ac62f43 100644 --- a/doc/directory_structure.md +++ b/doc/overview.md @@ -1,4 +1,4 @@ -# SPDK Directory Structure {#directory_structure} +# SPDK Structural Overview {#overview} # Overview {#dir_overview} diff --git a/doc/ssd_internals.md b/doc/ssd_internals.md index 532290fcb..f11ad9802 100644 --- a/doc/ssd_internals.md +++ b/doc/ssd_internals.md @@ -1,4 +1,4 @@ -# SSD Internals {#ssd_internals} +# NAND Flash SSD Internals {#ssd_internals} Solid State Devices (SSD) are complex devices and their performance depends on how they're used. The following description is intended to help software