docs/develop: introduce intermediate index for each section

The table of content of the top level will include everything that's up
to 2 levels down. Currently this results in a lot of pages and no clear
organization.

Extra index pages allow for more intermediate levels, resulting in less
things being listed in the main page. This way the organization is a bit
clearer, even if this is still not great due to many missing pages and
sections in the documentation currently.

Change-Id: I5bbdd96b3c2ff3334b9ad1b86fd9e7fb00fd63a6
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6008
Tested-by: Commit checker robot <[email protected]>
Reviewed-by: waddlesplash <[email protected]>
This commit is contained in:
Adrien Destugues
2023-01-19 22:09:22 +00:00
committed by Adrien Destugues
parent 7cfd9e92cf
commit 6b1db710f7
8 changed files with 77 additions and 45 deletions
+19
View File
@@ -0,0 +1,19 @@
Device drivers
##############
.. toctree::
:maxdepth: 2
/drivers/disk/ioctls
/drivers/intel_extreme/generations
Bus drivers
###########
.. toctree::
:maxdepth: 2
/busses/agp_gart/ReadMe
/busses/bluetooth/overview
/busses/sdhci/sdhci_mmc_driver
/busses/usb/USB_stack_design
+17
View File
@@ -0,0 +1,17 @@
Filesystem drivers
==================
Filesystem drivers are in src/add-ons/kernel/file_system
A filesystem usually relies on an underlying block device, but that's not
required. For example, NFS is a network filesystem, so it doesn't need one.
.. toctree::
/file_systems/overview
/file_systems/node_monitoring
/file_systems/userlandfs
/file_systems/ufs2
/file_systems/xfs
/file_systems/befs/resources
/partitioning_systems/sun
@@ -181,8 +181,6 @@ and its listeners will be removed as well, to prevent watching a new
file that accidently happen to have the same device/node pair (as is file that accidently happen to have the same device/node pair (as is
possible with BFS, for example). possible with BFS, for example).
|
Differences Between Both Implementations Differences Between Both Implementations
---------------------------------------- ----------------------------------------
@@ -205,8 +203,6 @@ The other difference is that OpenBeOS exports its node monitoring
functionality to kernel modules as well, and provides an extra plain C functionality to kernel modules as well, and provides an extra plain C
API for them to use. API for them to use.
|
And Beyond? And Beyond?
----------- -----------
@@ -232,7 +228,7 @@ disadvantages:
systems; a file system must be able to retrieve a node by ID only - systems; a file system must be able to retrieve a node by ID only -
it might not be feasible to find out about the parent directory for it might not be feasible to find out about the parent directory for
many file systems. many file systems.
#. Although it could potentially safe node monitors, it might cause the #. Although it could potentially save node monitors, it might cause the
kernel to send out a lot more messages to the application than it kernel to send out a lot more messages to the application than it
needs. With the restriction the kernel imposes to the number of needs. With the restriction the kernel imposes to the number of
watched nodes for a team, the application's designer might try to be watched nodes for a team, the application's designer might try to be
+2 -17
View File
@@ -1,13 +1,5 @@
Filesystem drivers File systems overview
================== ---------------------
Filesystem drivers are in src/add-ons/kernel/file_system
A filesystem usually relies on an underlying block device, but that's not
required. For example, NFS is a network filesystem, so it doesn't need one.
Implementation notes
--------------------
Each filesystem driver must define a few structures which act as the Each filesystem driver must define a few structures which act as the
interface between the VFS and the filesystem implementation. These interface between the VFS and the filesystem implementation. These
@@ -89,10 +81,3 @@ Torture and performance tests
Once the basic operations are working fine, it is a good idea to perform more Once the basic operations are working fine, it is a good idea to perform more
agressive testing. Examples of scripts doing this are available in agressive testing. Examples of scripts doing this are available in
src/tests/add-ons/kernel/file_systems/ for the fat and ext2 filesystems. src/tests/add-ons/kernel/file_systems/ for the fat and ext2 filesystems.
.. toctree::
/file_systems/userlandfs
/file_systems/ufs2
/file_systems/xfs
/file_systems/befs/resources
+5 -23
View File
@@ -40,31 +40,13 @@ Table of contents
/build/index /build/index
/release/index /release/index
/apps/haikudepot/server
/midi/index /midi/index
/net/NetworkStackOverview /net/index
/net/HowTo-Synchronize_with_NetBSD
/packages/README /packages/README
/servers/app_server/toc /servers/app_server/toc
/servers/registrar/Protocols /servers/registrar/Protocols
/kernel/device_manager_introduction /kernel/index
/kernel/obsolete_pnp_manager /file_systems/index
/kernel/vm/swap_file_support /drivers/index
/kernel/arch/long_double /apps/haikudepot/server
/kernel/arch/arm/overview
/kernel/arch/m68k/overview
/kernel/arch/ppc/overview
/kernel/arch/sparc/overview
/kernel/fs/node_monitoring
/file_systems/overview
/partitioning_systems/sun
/drivers/disk/ioctls
/drivers/intel_extreme/generations
/busses/agp_gart/ReadMe
/busses/bluetooth/overview
/busses/sdhci/sdhci_mmc_driver
/busses/usb/USB_stack_design
/kernel/boot/boot_process_specs.rst
/kernel/boot/Debugging_Bootloaders_GEF
/kernel/pci_serial_debug
+11
View File
@@ -0,0 +1,11 @@
CPU architectures
#################
.. toctree::
:maxdepth: 2
/kernel/arch/long_double
/kernel/arch/arm/overview
/kernel/arch/m68k/overview
/kernel/arch/ppc/overview
/kernel/arch/sparc/overview
+13
View File
@@ -0,0 +1,13 @@
Kernel
======
.. toctree::
:maxdepth: 2
/kernel/device_manager_introduction
/kernel/obsolete_pnp_manager
/kernel/vm/swap_file_support
/kernel/arch/index
/kernel/boot/boot_process_specs.rst
/kernel/boot/Debugging_Bootloaders_GEF
/kernel/pci_serial_debug
+9
View File
@@ -0,0 +1,9 @@
The Network Stack
#################
.. toctree::
:maxdepth: 2
/net/NetworkStackOverview
/net/HowTo-Synchronize_with_NetBSD