From 8a98ec7c7b3901330a036af0f62f523c31d763da Mon Sep 17 00:00:00 2001 From: "Darrick J. Wong" Date: Fri, 5 Oct 2018 19:20:08 -0400 Subject: [PATCH] docs: promote the ext4 data structures book to top level Move the ext4 data structures book to Documentation/filesystems/ext4/ since the administrative information moved elsewhere. Signed-off-by: Darrick J. Wong Signed-off-by: Theodore Ts'o --- Documentation/conf.py | 4 ++-- .../filesystems/ext4/{ondisk => }/about.rst | 0 .../ext4/{ondisk => }/allocators.rst | 0 .../ext4/{ondisk => }/attributes.rst | 0 .../filesystems/ext4/{ondisk => }/bigalloc.rst | 0 .../filesystems/ext4/{ondisk => }/bitmaps.rst | 0 .../ext4/{ondisk => }/blockgroup.rst | 0 .../filesystems/ext4/{ondisk => }/blockmap.rst | 0 .../filesystems/ext4/{ondisk => }/blocks.rst | 0 .../ext4/{ondisk => }/checksums.rst | 0 .../ext4/{ondisk => }/directory.rst | 0 .../filesystems/ext4/{ondisk => }/dynamic.rst | 0 .../filesystems/ext4/{ondisk => }/eainode.rst | 0 .../filesystems/ext4/{ondisk => }/globals.rst | 0 .../ext4/{ondisk => }/group_descr.rst | 0 .../filesystems/ext4/{ondisk => }/ifork.rst | 0 Documentation/filesystems/ext4/index.rst | 18 ++++++++---------- .../ext4/{ondisk => }/inlinedata.rst | 0 .../filesystems/ext4/{ondisk => }/inodes.rst | 0 .../filesystems/ext4/{ondisk => }/journal.rst | 0 .../filesystems/ext4/{ondisk => }/mmp.rst | 0 .../filesystems/ext4/ondisk/index.rst | 9 --------- .../filesystems/ext4/{ondisk => }/overview.rst | 0 .../ext4/{ondisk => }/special_inodes.rst | 0 .../filesystems/ext4/{ondisk => }/super.rst | 0 25 files changed, 10 insertions(+), 21 deletions(-) rename Documentation/filesystems/ext4/{ondisk => }/about.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/allocators.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/attributes.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/bigalloc.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/bitmaps.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/blockgroup.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/blockmap.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/blocks.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/checksums.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/directory.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/dynamic.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/eainode.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/globals.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/group_descr.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/ifork.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/inlinedata.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/inodes.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/journal.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/mmp.rst (100%) delete mode 100644 Documentation/filesystems/ext4/ondisk/index.rst rename Documentation/filesystems/ext4/{ondisk => }/overview.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/special_inodes.rst (100%) rename Documentation/filesystems/ext4/{ondisk => }/super.rst (100%) diff --git a/Documentation/conf.py b/Documentation/conf.py index 4d32c01e1e16..ede67ccafc29 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -385,8 +385,8 @@ latex_documents = [ 'The kernel development community', 'manual'), ('admin-guide/ext4', 'ext4-admin-guide.tex', 'ext4 Administration Guide', 'ext4 Community', 'manual'), - ('filesystems/ext4/index', 'ext4.tex', 'ext4 Filesystem', - 'ext4 Filesystem Developers', 'manual'), + ('filesystems/ext4/index', 'ext4-data-structures.tex', + 'ext4 Data Structures and Algorithms', 'ext4 Community', 'manual'), ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide', 'The kernel development community', 'manual'), ('input/index', 'linux-input.tex', 'The Linux input driver subsystem', diff --git a/Documentation/filesystems/ext4/ondisk/about.rst b/Documentation/filesystems/ext4/about.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/about.rst rename to Documentation/filesystems/ext4/about.rst diff --git a/Documentation/filesystems/ext4/ondisk/allocators.rst b/Documentation/filesystems/ext4/allocators.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/allocators.rst rename to Documentation/filesystems/ext4/allocators.rst diff --git a/Documentation/filesystems/ext4/ondisk/attributes.rst b/Documentation/filesystems/ext4/attributes.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/attributes.rst rename to Documentation/filesystems/ext4/attributes.rst diff --git a/Documentation/filesystems/ext4/ondisk/bigalloc.rst b/Documentation/filesystems/ext4/bigalloc.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/bigalloc.rst rename to Documentation/filesystems/ext4/bigalloc.rst diff --git a/Documentation/filesystems/ext4/ondisk/bitmaps.rst b/Documentation/filesystems/ext4/bitmaps.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/bitmaps.rst rename to Documentation/filesystems/ext4/bitmaps.rst diff --git a/Documentation/filesystems/ext4/ondisk/blockgroup.rst b/Documentation/filesystems/ext4/blockgroup.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/blockgroup.rst rename to Documentation/filesystems/ext4/blockgroup.rst diff --git a/Documentation/filesystems/ext4/ondisk/blockmap.rst b/Documentation/filesystems/ext4/blockmap.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/blockmap.rst rename to Documentation/filesystems/ext4/blockmap.rst diff --git a/Documentation/filesystems/ext4/ondisk/blocks.rst b/Documentation/filesystems/ext4/blocks.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/blocks.rst rename to Documentation/filesystems/ext4/blocks.rst diff --git a/Documentation/filesystems/ext4/ondisk/checksums.rst b/Documentation/filesystems/ext4/checksums.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/checksums.rst rename to Documentation/filesystems/ext4/checksums.rst diff --git a/Documentation/filesystems/ext4/ondisk/directory.rst b/Documentation/filesystems/ext4/directory.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/directory.rst rename to Documentation/filesystems/ext4/directory.rst diff --git a/Documentation/filesystems/ext4/ondisk/dynamic.rst b/Documentation/filesystems/ext4/dynamic.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/dynamic.rst rename to Documentation/filesystems/ext4/dynamic.rst diff --git a/Documentation/filesystems/ext4/ondisk/eainode.rst b/Documentation/filesystems/ext4/eainode.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/eainode.rst rename to Documentation/filesystems/ext4/eainode.rst diff --git a/Documentation/filesystems/ext4/ondisk/globals.rst b/Documentation/filesystems/ext4/globals.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/globals.rst rename to Documentation/filesystems/ext4/globals.rst diff --git a/Documentation/filesystems/ext4/ondisk/group_descr.rst b/Documentation/filesystems/ext4/group_descr.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/group_descr.rst rename to Documentation/filesystems/ext4/group_descr.rst diff --git a/Documentation/filesystems/ext4/ondisk/ifork.rst b/Documentation/filesystems/ext4/ifork.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/ifork.rst rename to Documentation/filesystems/ext4/ifork.rst diff --git a/Documentation/filesystems/ext4/index.rst b/Documentation/filesystems/ext4/index.rst index 427bc115012e..3be3e54d480d 100644 --- a/Documentation/filesystems/ext4/index.rst +++ b/Documentation/filesystems/ext4/index.rst @@ -1,16 +1,14 @@ .. SPDX-License-Identifier: GPL-2.0 -=============== -ext4 Filesystem -=============== - -General usage and on-disk artifacts writen by ext4. More documentation may -be ported from the wiki as time permits. This should be considered the -canonical source of information as the details here have been reviewed by -the ext4 community. +=================================== +ext4 Data Structures and Algorithms +=================================== .. toctree:: - :maxdepth: 5 + :maxdepth: 6 :numbered: - ondisk/index + about.rst + overview.rst + globals.rst + dynamic.rst diff --git a/Documentation/filesystems/ext4/ondisk/inlinedata.rst b/Documentation/filesystems/ext4/inlinedata.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/inlinedata.rst rename to Documentation/filesystems/ext4/inlinedata.rst diff --git a/Documentation/filesystems/ext4/ondisk/inodes.rst b/Documentation/filesystems/ext4/inodes.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/inodes.rst rename to Documentation/filesystems/ext4/inodes.rst diff --git a/Documentation/filesystems/ext4/ondisk/journal.rst b/Documentation/filesystems/ext4/journal.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/journal.rst rename to Documentation/filesystems/ext4/journal.rst diff --git a/Documentation/filesystems/ext4/ondisk/mmp.rst b/Documentation/filesystems/ext4/mmp.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/mmp.rst rename to Documentation/filesystems/ext4/mmp.rst diff --git a/Documentation/filesystems/ext4/ondisk/index.rst b/Documentation/filesystems/ext4/ondisk/index.rst deleted file mode 100644 index f7d082c3a435..000000000000 --- a/Documentation/filesystems/ext4/ondisk/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0 - -============================== -Data Structures and Algorithms -============================== -.. include:: about.rst -.. include:: overview.rst -.. include:: globals.rst -.. include:: dynamic.rst diff --git a/Documentation/filesystems/ext4/ondisk/overview.rst b/Documentation/filesystems/ext4/overview.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/overview.rst rename to Documentation/filesystems/ext4/overview.rst diff --git a/Documentation/filesystems/ext4/ondisk/special_inodes.rst b/Documentation/filesystems/ext4/special_inodes.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/special_inodes.rst rename to Documentation/filesystems/ext4/special_inodes.rst diff --git a/Documentation/filesystems/ext4/ondisk/super.rst b/Documentation/filesystems/ext4/super.rst similarity index 100% rename from Documentation/filesystems/ext4/ondisk/super.rst rename to Documentation/filesystems/ext4/super.rst