doc: move directory hierarchy to HTML

Move section 'Directory hierarchy' from file README to the HTML
documentation.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Simon Glass <sjg@chromium.org>

diff --git a/README b/README
index 5437a1bdc2048638c8f89a69f910aae28f5c53fa..8b395356dcf2bf2795afcdd7ad63c06211aa9cdf 100644 (file)
--- a/README
+++ b/README
@@ -105,44 +105,6 @@ the string "u_boot" or on "U_BOOT". Example:
        IH_OS_U_BOOT            u_boot_hush_start
 
 
-Directory Hierarchy:
-====================
-
-/arch                  Architecture-specific files
-  /arc                 Files generic to ARC architecture
-  /arm                 Files generic to ARM architecture
-  /m68k                        Files generic to m68k architecture
-  /microblaze          Files generic to microblaze architecture
-  /mips                        Files generic to MIPS architecture
-  /nios2               Files generic to Altera NIOS2 architecture
-  /powerpc             Files generic to PowerPC architecture
-  /riscv               Files generic to RISC-V architecture
-  /sandbox             Files generic to HW-independent "sandbox"
-  /sh                  Files generic to SH architecture
-  /x86                 Files generic to x86 architecture
-  /xtensa              Files generic to Xtensa architecture
-/api                   Machine/arch-independent API for external apps
-/board                 Board-dependent files
-/boot                  Support for images and booting
-/cmd                   U-Boot commands functions
-/common                        Misc architecture-independent functions
-/configs               Board default configuration files
-/disk                  Code for disk drive partition handling
-/doc                   Documentation (a mix of ReST and READMEs)
-/drivers               Device drivers
-/dts                   Makefile for building internal U-Boot fdt.
-/env                   Environment support
-/examples              Example code for standalone applications, etc.
-/fs                    Filesystem code (cramfs, ext2, jffs2, etc.)
-/include               Header Files
-/lib                   Library routines generic to all architectures
-/Licenses              Various license files
-/net                   Networking code
-/post                  Power On Self Test
-/scripts               Various build scripts and Makefiles
-/test                  Various unit test files
-/tools                 Tools to build and sign FIT images, etc.
-
 Software Configuration:
 =======================
 

diff --git a/doc/develop/directories.rst b/doc/develop/directories.rst
new file mode 100644 (file)
index 0000000..112b565
--- /dev/null
+++ b/doc/develop/directories.rst
@@ -0,0 +1,76 @@
+Directory hierarchy
+===================
+
+.. list-table::
+   :header-rows: 1
+
+   * - Directory path
+     - Usage
+   * - /arch
+     - Architecture-specific files
+   * - /arch/arc
+     - Files relating to ARC architecture
+   * - /arch/arm
+     - Files relating to ARM architecture
+   * - /arch/m68k
+     - Files relating to m68k architecture
+   * - /arch/microblaze
+     - Files relating to microblaze architecture
+   * - /arch/mips
+     - Files relating to MIPS architecture
+   * - /arch/nios2
+     - Files relating to Altera NIOS2 architecture
+   * - /arch/powerpc
+     - Files relating to PowerPC architecture
+   * - /arch/riscv
+     - Files relating to RISC-V architecture
+   * - /arch/sandbox
+     - Files relating to HW-independent "sandbox"
+   * - /arch/sh
+     - Files relating to SH architecture
+   * - /arch/x86
+     - Files relating to x86 architecture
+   * - /arch/xtensa
+     - Files relating to Xtensa architecture
+   * - /api
+     - Machine/arch-independent API for external apps
+   * - /board
+     - Board-dependent files
+   * - /boot
+     - Support for images and booting
+   * - /cmd
+     - U-Boot commands functions
+   * - /common
+     - Misc architecture-independent functions
+   * - /configs
+     - Board default configuration files
+   * - /disk
+     - Code for disk drive partition handling
+   * - /doc
+     - Documentation (a mix of ReST and READMEs)
+   * - /drivers
+     - Device drivers
+   * - /dts
+     - Makefile for building internal U-Boot fdt.
+   * - /env
+     - Environment support
+   * - /examples
+     - Example code for standalone applications, etc.
+   * - /fs
+     - Filesystem code (cramfs, ext2, jffs2, etc.)
+   * - /include
+     - Header Files
+   * - /lib
+     - Library routines relating to all architectures
+   * - /Licenses
+     - Various license files
+   * - /net
+     - Networking code
+   * - /post
+     - Power On Self Test
+   * - /scripts
+     - Various build scripts and Makefiles
+   * - /test
+     - Various unit test files
+   * - /tools
+     - Tools to build and sign FIT images, etc.

diff --git a/doc/develop/index.rst b/doc/develop/index.rst
index 79d7736b13436cfd33eb5b030bcd3a4d10a7f2b5..a52ad630d0d339ec795368b88087cf921a1019d7 100644 (file)
--- a/doc/develop/index.rst
+++ b/doc/develop/index.rst
@@ -24,6 +24,7 @@ Implementation
 .. toctree::
    :maxdepth: 1
 
+   directories
    bloblist
    bootstd
    ci_testing