From 5c884184286435142e92bd034215f9abff0d8bb6 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Tue, 14 Dec 2021 14:31:54 -0500 Subject: [PATCH] doc: build: move build docs one level up This is now a top level section. Signed-off-by: Anas Nashif --- MAINTAINERS.yml | 4 ++-- .../build/build-build-phase-1.svg | 0 .../build/build-build-phase-2.svg | 0 .../build/build-build-phase-3.svg | 0 .../build/build-build-phase-4.svg | 0 .../build/build-build-phase-5.svg | 0 .../build/build-build-phase-6.svg | 0 doc/{guides => }/build/build-config-phase.svg | 0 .../build/build-postprocess-1.svg | 0 .../build/build-postprocess-2.svg | 0 .../build/build-postprocess-3.svg | 0 .../build/build-postprocess-4.svg | 0 doc/{guides => }/build/index.rst | 20 +++++++++--------- doc/{guides => }/build/kconfig/extensions.rst | 0 .../build/kconfig/guiconfig-jump-to.png | Bin doc/{guides => }/build/kconfig/guiconfig.png | Bin .../build/kconfig/menuconfig-jump-to.png | Bin .../build/kconfig/menuconfig-quit.png | Bin doc/{guides => }/build/kconfig/menuconfig.png | Bin doc/{guides => }/build/kconfig/menuconfig.rst | 0 .../build/kconfig/preprocessor-functions.rst | 0 doc/{guides => }/build/kconfig/setting.rst | 0 doc/{guides => }/build/kconfig/tips.rst | 0 doc/index-tex.rst | 2 +- doc/index.rst | 2 +- 25 files changed, 14 insertions(+), 14 deletions(-) rename doc/{guides => }/build/build-build-phase-1.svg (100%) rename doc/{guides => }/build/build-build-phase-2.svg (100%) rename doc/{guides => }/build/build-build-phase-3.svg (100%) rename doc/{guides => }/build/build-build-phase-4.svg (100%) rename doc/{guides => }/build/build-build-phase-5.svg (100%) rename doc/{guides => }/build/build-build-phase-6.svg (100%) rename doc/{guides => }/build/build-config-phase.svg (100%) rename doc/{guides => }/build/build-postprocess-1.svg (100%) rename doc/{guides => }/build/build-postprocess-2.svg (100%) rename doc/{guides => }/build/build-postprocess-3.svg (100%) rename doc/{guides => }/build/build-postprocess-4.svg (100%) rename doc/{guides => }/build/index.rst (97%) rename doc/{guides => }/build/kconfig/extensions.rst (100%) rename doc/{guides => }/build/kconfig/guiconfig-jump-to.png (100%) rename doc/{guides => }/build/kconfig/guiconfig.png (100%) rename doc/{guides => }/build/kconfig/menuconfig-jump-to.png (100%) rename doc/{guides => }/build/kconfig/menuconfig-quit.png (100%) rename doc/{guides => }/build/kconfig/menuconfig.png (100%) rename doc/{guides => }/build/kconfig/menuconfig.rst (100%) rename doc/{guides => }/build/kconfig/preprocessor-functions.rst (100%) rename doc/{guides => }/build/kconfig/setting.rst (100%) rename doc/{guides => }/build/kconfig/tips.rst (100%) diff --git a/MAINTAINERS.yml b/MAINTAINERS.yml index ce146b2dd0..f97f9675c0 100644 --- a/MAINTAINERS.yml +++ b/MAINTAINERS.yml @@ -265,7 +265,7 @@ Build system: - CMakeLists.txt - scripts/zephyr_module.py - share/ - - doc/guides/build/ + - doc/build/ - doc/guides/modules.rst labels: - "area: Build System" @@ -1054,7 +1054,7 @@ Kconfig: - nashif files: - scripts/kconfig/ - - doc/guides/build/kconfig/ + - doc/build/kconfig/ labels: - "area: Kconfig" description: >- diff --git a/doc/guides/build/build-build-phase-1.svg b/doc/build/build-build-phase-1.svg similarity index 100% rename from doc/guides/build/build-build-phase-1.svg rename to doc/build/build-build-phase-1.svg diff --git a/doc/guides/build/build-build-phase-2.svg b/doc/build/build-build-phase-2.svg similarity index 100% rename from doc/guides/build/build-build-phase-2.svg rename to doc/build/build-build-phase-2.svg diff --git a/doc/guides/build/build-build-phase-3.svg b/doc/build/build-build-phase-3.svg similarity index 100% rename from doc/guides/build/build-build-phase-3.svg rename to doc/build/build-build-phase-3.svg diff --git a/doc/guides/build/build-build-phase-4.svg b/doc/build/build-build-phase-4.svg similarity index 100% rename from doc/guides/build/build-build-phase-4.svg rename to doc/build/build-build-phase-4.svg diff --git a/doc/guides/build/build-build-phase-5.svg b/doc/build/build-build-phase-5.svg similarity index 100% rename from doc/guides/build/build-build-phase-5.svg rename to doc/build/build-build-phase-5.svg diff --git a/doc/guides/build/build-build-phase-6.svg b/doc/build/build-build-phase-6.svg similarity index 100% rename from doc/guides/build/build-build-phase-6.svg rename to doc/build/build-build-phase-6.svg diff --git a/doc/guides/build/build-config-phase.svg b/doc/build/build-config-phase.svg similarity index 100% rename from doc/guides/build/build-config-phase.svg rename to doc/build/build-config-phase.svg diff --git a/doc/guides/build/build-postprocess-1.svg b/doc/build/build-postprocess-1.svg similarity index 100% rename from doc/guides/build/build-postprocess-1.svg rename to doc/build/build-postprocess-1.svg diff --git a/doc/guides/build/build-postprocess-2.svg b/doc/build/build-postprocess-2.svg similarity index 100% rename from doc/guides/build/build-postprocess-2.svg rename to doc/build/build-postprocess-2.svg diff --git a/doc/guides/build/build-postprocess-3.svg b/doc/build/build-postprocess-3.svg similarity index 100% rename from doc/guides/build/build-postprocess-3.svg rename to doc/build/build-postprocess-3.svg diff --git a/doc/guides/build/build-postprocess-4.svg b/doc/build/build-postprocess-4.svg similarity index 100% rename from doc/guides/build/build-postprocess-4.svg rename to doc/build/build-postprocess-4.svg diff --git a/doc/guides/build/index.rst b/doc/build/index.rst similarity index 97% rename from doc/guides/build/index.rst rename to doc/build/index.rst index 0a6f26cc03..4bc2c63a27 100644 --- a/doc/guides/build/index.rst +++ b/doc/build/index.rst @@ -338,7 +338,7 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`scripts/gen_syscalls.py` -------------------------------------- -.. include:: ../../../scripts/gen_syscalls.py +.. include:: ../../scripts/gen_syscalls.py :start-after: """ :end-before: """ @@ -347,7 +347,7 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`scripts/gen_handles.py` -------------------------------------- -.. include:: ../../../scripts/gen_handles.py +.. include:: ../../scripts/gen_handles.py :start-after: """ :end-before: """ @@ -356,7 +356,7 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`scripts/gen_kobject_list.py` ------------------------------------------ -.. include:: ../../../scripts/gen_kobject_list.py +.. include:: ../../scripts/gen_kobject_list.py :start-after: """ :end-before: """ @@ -365,7 +365,7 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`scripts/gen_offset_header.py` ------------------------------------------- -.. include:: ../../../scripts/gen_offset_header.py +.. include:: ../../scripts/gen_offset_header.py :start-after: """ :end-before: """ @@ -375,7 +375,7 @@ The following is a detailed description of the scripts used during the build pro ---------------------------------------- -.. include:: ../../../scripts/parse_syscalls.py +.. include:: ../../scripts/parse_syscalls.py :start-after: """ :end-before: """ @@ -384,7 +384,7 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`arch/x86/gen_idt.py` ---------------------------------- -.. include:: ../../../arch/x86/gen_idt.py +.. include:: ../../arch/x86/gen_idt.py :start-after: """ :end-before: """ @@ -393,7 +393,7 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`arch/x86/gen_gdt.py` ---------------------------------- -.. include:: ../../../arch/x86/gen_gdt.py +.. include:: ../../arch/x86/gen_gdt.py :start-after: """ :end-before: """ @@ -402,7 +402,7 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`scripts/gen_relocate_app.py` ------------------------------------------- -.. include:: ../../../scripts/gen_relocate_app.py +.. include:: ../../scripts/gen_relocate_app.py :start-after: """ :end-before: """ @@ -411,14 +411,14 @@ The following is a detailed description of the scripts used during the build pro :zephyr_file:`scripts/process_gperf.py` --------------------------------------- -.. include:: ../../../scripts/process_gperf.py +.. include:: ../../scripts/process_gperf.py :start-after: """ :end-before: """ :zephyr_file:`scripts/gen_app_partitions.py` -------------------------------------------- -.. include:: ../../../scripts/gen_app_partitions.py +.. include:: ../../scripts/gen_app_partitions.py :start-after: """ :end-before: """ diff --git a/doc/guides/build/kconfig/extensions.rst b/doc/build/kconfig/extensions.rst similarity index 100% rename from doc/guides/build/kconfig/extensions.rst rename to doc/build/kconfig/extensions.rst diff --git a/doc/guides/build/kconfig/guiconfig-jump-to.png b/doc/build/kconfig/guiconfig-jump-to.png similarity index 100% rename from doc/guides/build/kconfig/guiconfig-jump-to.png rename to doc/build/kconfig/guiconfig-jump-to.png diff --git a/doc/guides/build/kconfig/guiconfig.png b/doc/build/kconfig/guiconfig.png similarity index 100% rename from doc/guides/build/kconfig/guiconfig.png rename to doc/build/kconfig/guiconfig.png diff --git a/doc/guides/build/kconfig/menuconfig-jump-to.png b/doc/build/kconfig/menuconfig-jump-to.png similarity index 100% rename from doc/guides/build/kconfig/menuconfig-jump-to.png rename to doc/build/kconfig/menuconfig-jump-to.png diff --git a/doc/guides/build/kconfig/menuconfig-quit.png b/doc/build/kconfig/menuconfig-quit.png similarity index 100% rename from doc/guides/build/kconfig/menuconfig-quit.png rename to doc/build/kconfig/menuconfig-quit.png diff --git a/doc/guides/build/kconfig/menuconfig.png b/doc/build/kconfig/menuconfig.png similarity index 100% rename from doc/guides/build/kconfig/menuconfig.png rename to doc/build/kconfig/menuconfig.png diff --git a/doc/guides/build/kconfig/menuconfig.rst b/doc/build/kconfig/menuconfig.rst similarity index 100% rename from doc/guides/build/kconfig/menuconfig.rst rename to doc/build/kconfig/menuconfig.rst diff --git a/doc/guides/build/kconfig/preprocessor-functions.rst b/doc/build/kconfig/preprocessor-functions.rst similarity index 100% rename from doc/guides/build/kconfig/preprocessor-functions.rst rename to doc/build/kconfig/preprocessor-functions.rst diff --git a/doc/guides/build/kconfig/setting.rst b/doc/build/kconfig/setting.rst similarity index 100% rename from doc/guides/build/kconfig/setting.rst rename to doc/build/kconfig/setting.rst diff --git a/doc/guides/build/kconfig/tips.rst b/doc/build/kconfig/tips.rst similarity index 100% rename from doc/guides/build/kconfig/tips.rst rename to doc/build/kconfig/tips.rst diff --git a/doc/index-tex.rst b/doc/index-tex.rst index 9d9c0944c6..35c1a85999 100644 --- a/doc/index-tex.rst +++ b/doc/index-tex.rst @@ -16,9 +16,9 @@ Zephyr Project Documentation introduction/index.rst getting_started/index.rst contribute/index.rst + build/index.rst kernel/index.rst development_process/index.rst - guides/build/index.rst application/index.rst reference/index.rst guides/index.rst diff --git a/doc/index.rst b/doc/index.rst index 569407d8c3..fded6d728a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -105,8 +105,8 @@ Sections getting_started/index.rst contribute/index.rst development_process/index.rst - guides/build/index.rst application/index.rst + build/index.rst kernel/index.rst reference/index.rst guides/index.rst