diff --git a/doc/index.rst b/doc/index.rst index b4b03f3e94..bf2473313a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -13,7 +13,7 @@ :maxdepth: 1 quick_start/quick_start.rst - zephyr_kernel + kernel/kernel.rst zephyr_project diff --git a/doc/object/object.rst b/doc/kernel/kernel.rst similarity index 60% rename from doc/object/object.rst rename to doc/kernel/kernel.rst index 8a74b3341b..e47d58bd34 100644 --- a/doc/object/object.rst +++ b/doc/kernel/kernel.rst @@ -1,17 +1,26 @@ -Zephyr Kernel Objects -###################### +.. _zephyr_kernel: -Use this information to understand how the different kernel objects of -the Zephyr Kernel function. The purpose of this section is to help you -understand the most important object of the operating system. In order -to help you navigate through the content, we have divided the objects -in :ref:`basicObjects`, :ref:`nanokernelObjects` and -:ref:`microkernelObjects` objects. +The Zephyr Kernel +################# -We strongly recommend that you start with the :ref:`basicObjects` before -moving on to the :ref:`nanokernelObjects` or the -:ref:`microkernelObjects`. Additionally, we have included some -:ref:`driverExamples` for better comprehension of the objects' function. +The purpose of this section is to help you understand the operation of the kernel and its features. +This section also provides detailed information regarding the microkernel and the nanokernel +services. Finally, you can find the information regarding the kernel's drivers and networking +capabilities. + +This section does not replace the Application Program Interface +documentation, rather, it offers additional information. The examples should provide +you with enough insight to understand the functionality of the services but are not +meant to replace the detailed in-code documentation. + +.. toctree:: + :maxdepth: 2 + + overview/overview.rst + microkernel/microkernel.rst + nanokernel/nanokernel.rst + drivers/drivers.rst + networking/networking.rst .. rubric:: Abbreviations @@ -27,11 +36,4 @@ moving on to the :ref:`nanokernelObjects` or the | IDT | Interrupt Descriptor Table | +---------------+-------------------------------------------------------------------+ | XIP | eXecute In Place | -+---------------+-------------------------------------------------------------------+ - -.. toctree:: - :maxdepth: 2 - - contexts.rst - microkernel.rst - nanokernel.rst ++---------------+-------------------------------------------------------------------+ \ No newline at end of file diff --git a/doc/object/contexts.rst b/doc/object/contexts.rst deleted file mode 100644 index 0ae3e2f639..0000000000 --- a/doc/object/contexts.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _basicObjects: - -Execution Contexts -################## - -Tasks, fibers and interrupt service routines serve as the basis of the -operating system functionality. The purpose of this section is to -describe how this execution contexts operate, their behavior and their -implementation. Using this information you should be able to understand -what each context is capable of, how it operates and where its limits -are. - -This section does not replace the Application Program Interface -documentation but rather complements it. The examples should provide -you with enough insight to understand the functionality but are not -meant to replace the detailed in-code documentation. - - - -.. toctree:: - :maxdepth: 2 - - - fibers.rst - interrupts.rst - tasks.rst diff --git a/doc/zephyr_kernel.rst b/doc/zephyr_kernel.rst deleted file mode 100644 index 7654210c8c..0000000000 --- a/doc/zephyr_kernel.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _zephyr_kernel: - -The Zephyr Kernel -################# - -This section contains the information about the kernel's code. - -.. toctree:: - :maxdepth: 2 - - architecture/architecture.rst - object/object.rst - net/network.rst - platform/platform.rst - doxygen/doxygen_output.rst - development/development.rst \ No newline at end of file