From 8a703ca6ef6a7983a38b90a2c76f5fa96ac44e2b Mon Sep 17 00:00:00 2001
From: Jim Harris <james.r.harris@intel.com>
Date: Tue, 28 Aug 2018 12:39:02 -0700
Subject: [PATCH] doc: add comment explaining order of INPUT file list

While here, reorder some of the files alphabetically.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I78d7e31e55d94ed4473fa7d3c96fa3fb8481444a

Reviewed-on: https://review.gerrithub.io/423752
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
---
 doc/Doxyfile | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

diff --git a/doc/Doxyfile b/doc/Doxyfile
index 01969b890..c451499cd 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -782,7 +782,11 @@ WARN_LOGFILE           =
 
 INPUT                  = ../include/spdk \
                          index.md \
-                         \
+
+# This list contains the top level pages listed in index.md.  This list should
+# remain in the same order as the contents of index.md.  The order here also
+# determines the order of these sections in the left-side navigation bar.
+INPUT                  += \
                          intro.md \
                          concepts.md \
                          user_guides.md \
@@ -793,30 +797,32 @@ INPUT                  = ../include/spdk \
                          tools.md \
                          experimental_tools.md \
                          performance_reports.md \
-                         \
+
+# All remaining pages are listed here in alphabetical order by filename.
+INPUT                  += \
                          about.md \
                          applications.md \
-                         changelog.md \
-                         concurrency.md \
-                         directory_structure.md \
-                         getting_started.md \
-                         memory.md \
-                         porting.md \
                          bdev.md \
                          bdev_module.md \
                          bdev_pg.md \
                          blob.md \
                          blobfs.md \
+                         changelog.md \
+                         concurrency.md \
+                         directory_structure.md \
                          event.md \
+                         getting_started.md \
                          ioat.md \
                          iscsi.md \
                          jsonrpc.md \
                          lvol.md \
+                         memory.md \
                          nvme.md \
                          nvme-cli.md \
                          nvmf.md \
                          nvmf_tgt_pg.md \
                          peer_2_peer.md \
+                         porting.md \
                          spdkcli.md \
                          ssd_internals.md \
                          userspace.md \