From 903a32aceceb799e75e9aa98631d669e3a130b21 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Mon, 24 Feb 2025 09:58:36 +0800 Subject: [PATCH] doxygen: reorganize directory structure The original directory structure was too flat and inconvenient to view. The directory is now reorganized according to the first-level chapters, and some sub-chapters are moved to the second-level directory. Note: documentation/env is not moved to documentation/4.tool because there are too many external places that reference this path, especially in bsp, so this directory path remains as it is. Signed-off-by: Chen Wang --- .gitee/PULL_REQUEST_TEMPLATE.en.md | 2 +- .gitee/PULL_REQUEST_TEMPLATE.zh-CN.md | 2 +- documentation/{ => 3.kernel}/basic/basic.md | 0 .../basic/figures/03Memory_distribution.png | Bin .../basic/figures/03Startup_process.png | Bin .../basic/figures/03kernel_Framework.png | Bin .../basic/figures/03kernel_object.png | Bin .../basic/figures/03kernel_object2.png | Bin .../{ => 3.kernel}/interrupt/figures/09fun1.png | Bin .../{ => 3.kernel}/interrupt/figures/09fun2.png | Bin .../interrupt/figures/09interrupt_handle.png | Bin .../interrupt/figures/09interrupt_ops.png | Bin .../interrupt/figures/09interrupt_reque.png | Bin .../interrupt/figures/09interrupt_table.png | Bin .../interrupt/figures/09interrupt_work.png | Bin .../interrupt/figures/09interrupt_work_process.png | Bin .../interrupt/figures/09interrupt_work_sta.png | Bin .../{ => 3.kernel}/interrupt/figures/09relation.png | Bin .../interrupt/figures/09ths_switch.png | Bin documentation/{ => 3.kernel}/interrupt/interrupt.md | 0 .../kernel-porting/figures/10pendsv.png | Bin .../kernel-porting/figures/10stack.png | Bin .../kernel-porting/figures/10switch.png | Bin .../kernel-porting/figures/10switch2.png | Bin .../kernel-porting/figures/10ths_env1.png | Bin .../kernel-porting/figures/10ths_env2.png | Bin .../{ => 3.kernel}/kernel-porting/kernel-porting.md | 0 .../memory/figures/08Memory_distribution.png | Bin .../{ => 3.kernel}/memory/figures/08heap_ops.png | Bin .../{ => 3.kernel}/memory/figures/08memheap.png | Bin .../{ => 3.kernel}/memory/figures/08mempool.png | Bin .../{ => 3.kernel}/memory/figures/08mempool_ops.png | Bin .../memory/figures/08mempool_work.png | Bin .../{ => 3.kernel}/memory/figures/08slab.png | Bin .../{ => 3.kernel}/memory/figures/08smem_work.png | Bin .../{ => 3.kernel}/memory/figures/08smem_work2.png | Bin .../{ => 3.kernel}/memory/figures/08smem_work3.png | Bin .../{ => 3.kernel}/memory/figures/08smem_work4.png | Bin documentation/{ => 3.kernel}/memory/memory.md | 0 .../{ => 3.kernel}/thread-comm/figures/07mb_ops.png | Bin .../thread-comm/figures/07mb_work.png | Bin .../thread-comm/figures/07msg_ops.png | Bin .../thread-comm/figures/07msg_syn.png | Bin .../thread-comm/figures/07msg_work.png | Bin .../thread-comm/figures/07signal_ops.png | Bin .../thread-comm/figures/07signal_work.png | Bin .../{ => 3.kernel}/thread-comm/thread-comm.md | 0 .../thread-sync/figures/06event_ops.png | Bin .../thread-sync/figures/06event_use.png | Bin .../thread-sync/figures/06event_work.png | Bin .../thread-sync/figures/06inter_ths_commu1.png | Bin .../thread-sync/figures/06inter_ths_commu2.png | Bin .../thread-sync/figures/06mutex_ops.png | Bin .../thread-sync/figures/06mutex_work.png | Bin .../thread-sync/figures/06priority_inherit.png | Bin .../thread-sync/figures/06priority_inversion.png | Bin .../thread-sync/figures/06sem_lock.png | Bin .../thread-sync/figures/06sem_ops.png | Bin .../thread-sync/figures/06sem_work.png | Bin .../{ => 3.kernel}/thread-sync/thread-sync.md | 0 .../thread/figures/04Object_container.png | Bin .../thread/figures/04Task_switching.png | Bin .../{ => 3.kernel}/thread/figures/04main_thread.png | Bin .../{ => 3.kernel}/thread/figures/04thread_ops.png | Bin .../{ => 3.kernel}/thread/figures/04thread_sta.png | Bin .../thread/figures/04thread_stack.png | Bin .../thread/figures/04time_slience.png | Bin documentation/{ => 3.kernel}/thread/thread.md | 0 .../{ => 3.kernel}/timer/figures/05timer_env.png | Bin .../timer/figures/05timer_linked_list.png | Bin .../timer/figures/05timer_linked_list2.png | Bin .../{ => 3.kernel}/timer/figures/05timer_ops.png | Bin .../timer/figures/05timer_skip_list.png | Bin .../timer/figures/05timer_skip_list2.png | Bin .../timer/figures/05timer_skip_list3.png | Bin documentation/{ => 3.kernel}/timer/timer.md | 0 .../{ => 4.tool}/scons/figures/hello-menu.png | Bin .../{ => 4.tool}/scons/figures/hello-rtconfig.png | Bin .../{ => 4.tool}/scons/figures/hello-value.png | Bin documentation/{ => 4.tool}/scons/figures/hello.png | Bin .../{ => 4.tool}/scons/figures/kconfig.png | Bin .../{ => 4.tool}/scons/figures/scons_compile.png | Bin documentation/{ => 4.tool}/scons/scons.md | 0 documentation/{device => 5.device}/adc/adc.md | 0 .../{device => 5.device}/adc/figures/adc-p.png | Bin .../{device => 5.device/framework}/device.md | 0 .../framework}/figures/block-dev.png | Bin .../framework}/figures/io-call.png | Bin .../framework}/figures/io-dev.png | Bin .../framework}/figures/io-fun-call.png | Bin .../framework}/figures/io-parent.png | Bin .../framework}/figures/wtd-uml.png | Bin .../{device => 5.device}/hwtimer/hwtimer.md | 0 .../{device => 5.device}/i2c/figures/i2c1.png | Bin .../{device => 5.device}/i2c/figures/i2c2.png | Bin .../{device => 5.device}/i2c/figures/i2c3.png | Bin documentation/{device => 5.device}/i2c/i2c.md | 0 .../{device => 5.device}/pin/figures/pin2.png | Bin documentation/{device => 5.device}/pin/pin.md | 0 .../{device => 5.device}/pwm/figures/pwm-f.png | Bin .../{device => 5.device}/pwm/figures/pwm-l.png | Bin documentation/{device => 5.device}/pwm/pwm.md | 0 documentation/{device => 5.device}/rtc/rtc.md | 0 documentation/{device => 5.device}/sensor/sensor.md | 0 .../{device => 5.device}/spi/figures/spi1.png | Bin .../{device => 5.device}/spi/figures/spi2.png | Bin .../{device => 5.device}/spi/figures/spi5.png | Bin documentation/{device => 5.device}/spi/spi.md | 0 .../{device => 5.device}/uart/figures/uart-dma.png | Bin .../{device => 5.device}/uart/figures/uart-int.png | Bin .../{device => 5.device}/uart/figures/uart1.png | Bin documentation/{device => 5.device}/uart/uart.md | 0 .../{device => 5.device}/watchdog/watchdog.md | 0 .../{device => 5.device}/wlan/figures/an0026_1.png | Bin .../{device => 5.device}/wlan/figures/an0026_3.png | Bin .../{device => 5.device}/wlan/figures/an0026_4.png | Bin .../{device => 5.device}/wlan/figures/an0026_5.png | Bin documentation/{device => 5.device}/wlan/wlan.md | 0 documentation/{ => 6.components}/at/at.md | 0 .../{ => 6.components}/at/figures/at_framework.jpg | Bin .../at/figures/at_multiple_client.jpg | Bin documentation/{ => 6.components}/dlmodule/README.md | 0 .../{ => 6.components}/filesystem/README.md | 0 .../filesystem/figures/elm-fat-mkfs.png | Bin .../filesystem/figures/fs-dir-mg.png | Bin .../filesystem/figures/fs-dir.png | Bin .../filesystem/figures/fs-layer.png | Bin .../{ => 6.components}/filesystem/figures/fs-mg.png | Bin .../filesystem/figures/fs-reg-block.png | Bin .../filesystem/figures/fs-reg.png | Bin .../{ => 6.components}/finsh/figures/finsh-hd.png | Bin .../{ => 6.components}/finsh/figures/finsh-mdk.png | Bin .../{ => 6.components}/finsh/figures/finsh-run.png | Bin documentation/{ => 6.components}/finsh/finsh.md | 0 .../network/figures/net-hello.png | Bin .../network/figures/net-layer.png | Bin .../{ => 6.components}/network/figures/net-osi.png | Bin .../{ => 6.components}/network/figures/net-recv.png | Bin .../{ => 6.components}/network/figures/net-send.png | Bin .../network/figures/net-tcp-s.png | Bin .../{ => 6.components}/network/figures/net-tcp.png | Bin .../network/figures/net-udp-client.png | Bin .../network/figures/net-udp-server.png | Bin .../{ => 6.components}/network/figures/net-udp.png | Bin documentation/{ => 6.components}/network/network.md | 0 .../pm/figures/pm_architecture.png | Bin .../pm/figures/pm_description.png | Bin .../{ => 6.components}/pm/figures/pm_sequence.png | Bin .../{ => 6.components}/pm/figures/pm_system.png | Bin documentation/{ => 6.components}/pm/pm.md | 0 documentation/{ => 6.components}/posix/README.md | 0 .../{ => 6.components}/sal/figures/sal_frame.jpg | Bin documentation/{ => 6.components}/sal/sal.md | 0 .../ulog/figures/ulog_async_vs_sync.png | Bin .../ulog/figures/ulog_example.png | Bin .../ulog/figures/ulog_example_all_format.png | Bin .../ulog/figures/ulog_example_async.png | Bin .../ulog/figures/ulog_example_filter20.png | Bin .../ulog/figures/ulog_example_filter30.png | Bin .../ulog/figures/ulog_example_filter40.png | Bin .../ulog/figures/ulog_example_hexdump.png | Bin .../ulog/figures/ulog_example_syslog.png | Bin .../ulog/figures/ulog_framework.png | Bin .../ulog/figures/ulog_framework_backend.png | Bin .../ulog/figures/ulog_menuconfig_async.png | Bin .../ulog/figures/ulog_menuconfig_format.png | Bin .../ulog/figures/ulog_syslog_format.png | Bin documentation/{ => 6.components}/ulog/ulog.md | 0 .../utest/figures/UtestAppStruct-1.png | Bin .../utest/figures/UtestRunLogShow.png | Bin .../utest/figures/testcase-runflowchart.jpg | Bin documentation/{ => 6.components}/utest/utest.md | 0 .../coding_style_cn.md | 0 .../coding_style_en.md | 0 documentation/Doxyfile | 2 +- 175 files changed, 3 insertions(+), 3 deletions(-) rename documentation/{ => 3.kernel}/basic/basic.md (100%) rename documentation/{ => 3.kernel}/basic/figures/03Memory_distribution.png (100%) rename documentation/{ => 3.kernel}/basic/figures/03Startup_process.png (100%) rename documentation/{ => 3.kernel}/basic/figures/03kernel_Framework.png (100%) rename documentation/{ => 3.kernel}/basic/figures/03kernel_object.png (100%) rename documentation/{ => 3.kernel}/basic/figures/03kernel_object2.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09fun1.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09fun2.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09interrupt_handle.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09interrupt_ops.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09interrupt_reque.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09interrupt_table.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09interrupt_work.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09interrupt_work_process.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09interrupt_work_sta.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09relation.png (100%) rename documentation/{ => 3.kernel}/interrupt/figures/09ths_switch.png (100%) rename documentation/{ => 3.kernel}/interrupt/interrupt.md (100%) rename documentation/{ => 3.kernel}/kernel-porting/figures/10pendsv.png (100%) rename documentation/{ => 3.kernel}/kernel-porting/figures/10stack.png (100%) rename documentation/{ => 3.kernel}/kernel-porting/figures/10switch.png (100%) rename documentation/{ => 3.kernel}/kernel-porting/figures/10switch2.png (100%) rename documentation/{ => 3.kernel}/kernel-porting/figures/10ths_env1.png (100%) rename documentation/{ => 3.kernel}/kernel-porting/figures/10ths_env2.png (100%) rename documentation/{ => 3.kernel}/kernel-porting/kernel-porting.md (100%) rename documentation/{ => 3.kernel}/memory/figures/08Memory_distribution.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08heap_ops.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08memheap.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08mempool.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08mempool_ops.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08mempool_work.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08slab.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08smem_work.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08smem_work2.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08smem_work3.png (100%) rename documentation/{ => 3.kernel}/memory/figures/08smem_work4.png (100%) rename documentation/{ => 3.kernel}/memory/memory.md (100%) rename documentation/{ => 3.kernel}/thread-comm/figures/07mb_ops.png (100%) rename documentation/{ => 3.kernel}/thread-comm/figures/07mb_work.png (100%) rename documentation/{ => 3.kernel}/thread-comm/figures/07msg_ops.png (100%) rename documentation/{ => 3.kernel}/thread-comm/figures/07msg_syn.png (100%) rename documentation/{ => 3.kernel}/thread-comm/figures/07msg_work.png (100%) rename documentation/{ => 3.kernel}/thread-comm/figures/07signal_ops.png (100%) rename documentation/{ => 3.kernel}/thread-comm/figures/07signal_work.png (100%) rename documentation/{ => 3.kernel}/thread-comm/thread-comm.md (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06event_ops.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06event_use.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06event_work.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06inter_ths_commu1.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06inter_ths_commu2.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06mutex_ops.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06mutex_work.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06priority_inherit.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06priority_inversion.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06sem_lock.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06sem_ops.png (100%) rename documentation/{ => 3.kernel}/thread-sync/figures/06sem_work.png (100%) rename documentation/{ => 3.kernel}/thread-sync/thread-sync.md (100%) rename documentation/{ => 3.kernel}/thread/figures/04Object_container.png (100%) rename documentation/{ => 3.kernel}/thread/figures/04Task_switching.png (100%) rename documentation/{ => 3.kernel}/thread/figures/04main_thread.png (100%) rename documentation/{ => 3.kernel}/thread/figures/04thread_ops.png (100%) rename documentation/{ => 3.kernel}/thread/figures/04thread_sta.png (100%) rename documentation/{ => 3.kernel}/thread/figures/04thread_stack.png (100%) rename documentation/{ => 3.kernel}/thread/figures/04time_slience.png (100%) rename documentation/{ => 3.kernel}/thread/thread.md (100%) rename documentation/{ => 3.kernel}/timer/figures/05timer_env.png (100%) rename documentation/{ => 3.kernel}/timer/figures/05timer_linked_list.png (100%) rename documentation/{ => 3.kernel}/timer/figures/05timer_linked_list2.png (100%) rename documentation/{ => 3.kernel}/timer/figures/05timer_ops.png (100%) rename documentation/{ => 3.kernel}/timer/figures/05timer_skip_list.png (100%) rename documentation/{ => 3.kernel}/timer/figures/05timer_skip_list2.png (100%) rename documentation/{ => 3.kernel}/timer/figures/05timer_skip_list3.png (100%) rename documentation/{ => 3.kernel}/timer/timer.md (100%) rename documentation/{ => 4.tool}/scons/figures/hello-menu.png (100%) rename documentation/{ => 4.tool}/scons/figures/hello-rtconfig.png (100%) rename documentation/{ => 4.tool}/scons/figures/hello-value.png (100%) rename documentation/{ => 4.tool}/scons/figures/hello.png (100%) rename documentation/{ => 4.tool}/scons/figures/kconfig.png (100%) rename documentation/{ => 4.tool}/scons/figures/scons_compile.png (100%) rename documentation/{ => 4.tool}/scons/scons.md (100%) rename documentation/{device => 5.device}/adc/adc.md (100%) rename documentation/{device => 5.device}/adc/figures/adc-p.png (100%) rename documentation/{device => 5.device/framework}/device.md (100%) rename documentation/{device => 5.device/framework}/figures/block-dev.png (100%) rename documentation/{device => 5.device/framework}/figures/io-call.png (100%) rename documentation/{device => 5.device/framework}/figures/io-dev.png (100%) rename documentation/{device => 5.device/framework}/figures/io-fun-call.png (100%) rename documentation/{device => 5.device/framework}/figures/io-parent.png (100%) rename documentation/{device => 5.device/framework}/figures/wtd-uml.png (100%) rename documentation/{device => 5.device}/hwtimer/hwtimer.md (100%) rename documentation/{device => 5.device}/i2c/figures/i2c1.png (100%) rename documentation/{device => 5.device}/i2c/figures/i2c2.png (100%) rename documentation/{device => 5.device}/i2c/figures/i2c3.png (100%) rename documentation/{device => 5.device}/i2c/i2c.md (100%) rename documentation/{device => 5.device}/pin/figures/pin2.png (100%) rename documentation/{device => 5.device}/pin/pin.md (100%) rename documentation/{device => 5.device}/pwm/figures/pwm-f.png (100%) rename documentation/{device => 5.device}/pwm/figures/pwm-l.png (100%) rename documentation/{device => 5.device}/pwm/pwm.md (100%) rename documentation/{device => 5.device}/rtc/rtc.md (100%) rename documentation/{device => 5.device}/sensor/sensor.md (100%) rename documentation/{device => 5.device}/spi/figures/spi1.png (100%) rename documentation/{device => 5.device}/spi/figures/spi2.png (100%) rename documentation/{device => 5.device}/spi/figures/spi5.png (100%) rename documentation/{device => 5.device}/spi/spi.md (100%) rename documentation/{device => 5.device}/uart/figures/uart-dma.png (100%) rename documentation/{device => 5.device}/uart/figures/uart-int.png (100%) rename documentation/{device => 5.device}/uart/figures/uart1.png (100%) rename documentation/{device => 5.device}/uart/uart.md (100%) rename documentation/{device => 5.device}/watchdog/watchdog.md (100%) rename documentation/{device => 5.device}/wlan/figures/an0026_1.png (100%) rename documentation/{device => 5.device}/wlan/figures/an0026_3.png (100%) rename documentation/{device => 5.device}/wlan/figures/an0026_4.png (100%) rename documentation/{device => 5.device}/wlan/figures/an0026_5.png (100%) rename documentation/{device => 5.device}/wlan/wlan.md (100%) rename documentation/{ => 6.components}/at/at.md (100%) rename documentation/{ => 6.components}/at/figures/at_framework.jpg (100%) rename documentation/{ => 6.components}/at/figures/at_multiple_client.jpg (100%) rename documentation/{ => 6.components}/dlmodule/README.md (100%) rename documentation/{ => 6.components}/filesystem/README.md (100%) rename documentation/{ => 6.components}/filesystem/figures/elm-fat-mkfs.png (100%) rename documentation/{ => 6.components}/filesystem/figures/fs-dir-mg.png (100%) rename documentation/{ => 6.components}/filesystem/figures/fs-dir.png (100%) rename documentation/{ => 6.components}/filesystem/figures/fs-layer.png (100%) rename documentation/{ => 6.components}/filesystem/figures/fs-mg.png (100%) rename documentation/{ => 6.components}/filesystem/figures/fs-reg-block.png (100%) rename documentation/{ => 6.components}/filesystem/figures/fs-reg.png (100%) rename documentation/{ => 6.components}/finsh/figures/finsh-hd.png (100%) rename documentation/{ => 6.components}/finsh/figures/finsh-mdk.png (100%) rename documentation/{ => 6.components}/finsh/figures/finsh-run.png (100%) rename documentation/{ => 6.components}/finsh/finsh.md (100%) rename documentation/{ => 6.components}/network/figures/net-hello.png (100%) rename documentation/{ => 6.components}/network/figures/net-layer.png (100%) rename documentation/{ => 6.components}/network/figures/net-osi.png (100%) rename documentation/{ => 6.components}/network/figures/net-recv.png (100%) rename documentation/{ => 6.components}/network/figures/net-send.png (100%) rename documentation/{ => 6.components}/network/figures/net-tcp-s.png (100%) rename documentation/{ => 6.components}/network/figures/net-tcp.png (100%) rename documentation/{ => 6.components}/network/figures/net-udp-client.png (100%) rename documentation/{ => 6.components}/network/figures/net-udp-server.png (100%) rename documentation/{ => 6.components}/network/figures/net-udp.png (100%) rename documentation/{ => 6.components}/network/network.md (100%) rename documentation/{ => 6.components}/pm/figures/pm_architecture.png (100%) rename documentation/{ => 6.components}/pm/figures/pm_description.png (100%) rename documentation/{ => 6.components}/pm/figures/pm_sequence.png (100%) rename documentation/{ => 6.components}/pm/figures/pm_system.png (100%) rename documentation/{ => 6.components}/pm/pm.md (100%) rename documentation/{ => 6.components}/posix/README.md (100%) rename documentation/{ => 6.components}/sal/figures/sal_frame.jpg (100%) rename documentation/{ => 6.components}/sal/sal.md (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_async_vs_sync.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example_all_format.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example_async.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example_filter20.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example_filter30.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example_filter40.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example_hexdump.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_example_syslog.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_framework.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_framework_backend.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_menuconfig_async.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_menuconfig_format.png (100%) rename documentation/{ => 6.components}/ulog/figures/ulog_syslog_format.png (100%) rename documentation/{ => 6.components}/ulog/ulog.md (100%) rename documentation/{ => 6.components}/utest/figures/UtestAppStruct-1.png (100%) rename documentation/{ => 6.components}/utest/figures/UtestRunLogShow.png (100%) rename documentation/{ => 6.components}/utest/figures/testcase-runflowchart.jpg (100%) rename documentation/{ => 6.components}/utest/utest.md (100%) rename documentation/{contribution_guide => 7.contribution}/coding_style_cn.md (100%) rename documentation/{contribution_guide => 7.contribution}/coding_style_en.md (100%) diff --git a/.gitee/PULL_REQUEST_TEMPLATE.en.md b/.gitee/PULL_REQUEST_TEMPLATE.en.md index 7696cf07853..3fc593d914d 100644 --- a/.gitee/PULL_REQUEST_TEMPLATE.en.md +++ b/.gitee/PULL_REQUEST_TEMPLATE.en.md @@ -27,4 +27,4 @@ As part of this pull request, I've considered the following: - [ ] All modifications to BSP are justified and do not affect other components or BSPs. - [ ] I've commented appropriately where code is tricky. - [ ] Code in this PR is of high quality. -- [ ] This PR complies with [RT-Thread code specification](https://gitee.com/rtthread/rt-thread/blob/master/documentation/contribution_guide/coding_style_en.md) +- [ ] This PR complies with [RT-Thread code specification](https://gitee.com/rtthread/rt-thread/blob/master/documentation/7.contribution/coding_style_en.md) diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md index 69bf3c2eb88..3e7807d5c40 100644 --- a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md +++ b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md @@ -27,4 +27,4 @@ - [ ] 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或 - [ ] 对难懂代码均提供对应的注释 - [ ] 本拉取/合并请求代码是高质量的 -- [ ] 本拉取/合并符合[RT-Thread代码规范](https://gitee.com/rtthread/rt-thread/blob/master/documentation/contribution_guide/coding_style_cn.md) +- [ ] 本拉取/合并符合[RT-Thread代码规范](https://gitee.com/rtthread/rt-thread/blob/master/documentation/7.contribution/coding_style_cn.md) diff --git a/documentation/basic/basic.md b/documentation/3.kernel/basic/basic.md similarity index 100% rename from documentation/basic/basic.md rename to documentation/3.kernel/basic/basic.md diff --git a/documentation/basic/figures/03Memory_distribution.png b/documentation/3.kernel/basic/figures/03Memory_distribution.png similarity index 100% rename from documentation/basic/figures/03Memory_distribution.png rename to documentation/3.kernel/basic/figures/03Memory_distribution.png diff --git a/documentation/basic/figures/03Startup_process.png b/documentation/3.kernel/basic/figures/03Startup_process.png similarity index 100% rename from documentation/basic/figures/03Startup_process.png rename to documentation/3.kernel/basic/figures/03Startup_process.png diff --git a/documentation/basic/figures/03kernel_Framework.png b/documentation/3.kernel/basic/figures/03kernel_Framework.png similarity index 100% rename from documentation/basic/figures/03kernel_Framework.png rename to documentation/3.kernel/basic/figures/03kernel_Framework.png diff --git a/documentation/basic/figures/03kernel_object.png b/documentation/3.kernel/basic/figures/03kernel_object.png similarity index 100% rename from documentation/basic/figures/03kernel_object.png rename to documentation/3.kernel/basic/figures/03kernel_object.png diff --git a/documentation/basic/figures/03kernel_object2.png b/documentation/3.kernel/basic/figures/03kernel_object2.png similarity index 100% rename from documentation/basic/figures/03kernel_object2.png rename to documentation/3.kernel/basic/figures/03kernel_object2.png diff --git a/documentation/interrupt/figures/09fun1.png b/documentation/3.kernel/interrupt/figures/09fun1.png similarity index 100% rename from documentation/interrupt/figures/09fun1.png rename to documentation/3.kernel/interrupt/figures/09fun1.png diff --git a/documentation/interrupt/figures/09fun2.png b/documentation/3.kernel/interrupt/figures/09fun2.png similarity index 100% rename from documentation/interrupt/figures/09fun2.png rename to documentation/3.kernel/interrupt/figures/09fun2.png diff --git a/documentation/interrupt/figures/09interrupt_handle.png b/documentation/3.kernel/interrupt/figures/09interrupt_handle.png similarity index 100% rename from documentation/interrupt/figures/09interrupt_handle.png rename to documentation/3.kernel/interrupt/figures/09interrupt_handle.png diff --git a/documentation/interrupt/figures/09interrupt_ops.png b/documentation/3.kernel/interrupt/figures/09interrupt_ops.png similarity index 100% rename from documentation/interrupt/figures/09interrupt_ops.png rename to documentation/3.kernel/interrupt/figures/09interrupt_ops.png diff --git a/documentation/interrupt/figures/09interrupt_reque.png b/documentation/3.kernel/interrupt/figures/09interrupt_reque.png similarity index 100% rename from documentation/interrupt/figures/09interrupt_reque.png rename to documentation/3.kernel/interrupt/figures/09interrupt_reque.png diff --git a/documentation/interrupt/figures/09interrupt_table.png b/documentation/3.kernel/interrupt/figures/09interrupt_table.png similarity index 100% rename from documentation/interrupt/figures/09interrupt_table.png rename to documentation/3.kernel/interrupt/figures/09interrupt_table.png diff --git a/documentation/interrupt/figures/09interrupt_work.png b/documentation/3.kernel/interrupt/figures/09interrupt_work.png similarity index 100% rename from documentation/interrupt/figures/09interrupt_work.png rename to documentation/3.kernel/interrupt/figures/09interrupt_work.png diff --git a/documentation/interrupt/figures/09interrupt_work_process.png b/documentation/3.kernel/interrupt/figures/09interrupt_work_process.png similarity index 100% rename from documentation/interrupt/figures/09interrupt_work_process.png rename to documentation/3.kernel/interrupt/figures/09interrupt_work_process.png diff --git a/documentation/interrupt/figures/09interrupt_work_sta.png b/documentation/3.kernel/interrupt/figures/09interrupt_work_sta.png similarity index 100% rename from documentation/interrupt/figures/09interrupt_work_sta.png rename to documentation/3.kernel/interrupt/figures/09interrupt_work_sta.png diff --git a/documentation/interrupt/figures/09relation.png b/documentation/3.kernel/interrupt/figures/09relation.png similarity index 100% rename from documentation/interrupt/figures/09relation.png rename to documentation/3.kernel/interrupt/figures/09relation.png diff --git a/documentation/interrupt/figures/09ths_switch.png b/documentation/3.kernel/interrupt/figures/09ths_switch.png similarity index 100% rename from documentation/interrupt/figures/09ths_switch.png rename to documentation/3.kernel/interrupt/figures/09ths_switch.png diff --git a/documentation/interrupt/interrupt.md b/documentation/3.kernel/interrupt/interrupt.md similarity index 100% rename from documentation/interrupt/interrupt.md rename to documentation/3.kernel/interrupt/interrupt.md diff --git a/documentation/kernel-porting/figures/10pendsv.png b/documentation/3.kernel/kernel-porting/figures/10pendsv.png similarity index 100% rename from documentation/kernel-porting/figures/10pendsv.png rename to documentation/3.kernel/kernel-porting/figures/10pendsv.png diff --git a/documentation/kernel-porting/figures/10stack.png b/documentation/3.kernel/kernel-porting/figures/10stack.png similarity index 100% rename from documentation/kernel-porting/figures/10stack.png rename to documentation/3.kernel/kernel-porting/figures/10stack.png diff --git a/documentation/kernel-porting/figures/10switch.png b/documentation/3.kernel/kernel-porting/figures/10switch.png similarity index 100% rename from documentation/kernel-porting/figures/10switch.png rename to documentation/3.kernel/kernel-porting/figures/10switch.png diff --git a/documentation/kernel-porting/figures/10switch2.png b/documentation/3.kernel/kernel-porting/figures/10switch2.png similarity index 100% rename from documentation/kernel-porting/figures/10switch2.png rename to documentation/3.kernel/kernel-porting/figures/10switch2.png diff --git a/documentation/kernel-porting/figures/10ths_env1.png b/documentation/3.kernel/kernel-porting/figures/10ths_env1.png similarity index 100% rename from documentation/kernel-porting/figures/10ths_env1.png rename to documentation/3.kernel/kernel-porting/figures/10ths_env1.png diff --git a/documentation/kernel-porting/figures/10ths_env2.png b/documentation/3.kernel/kernel-porting/figures/10ths_env2.png similarity index 100% rename from documentation/kernel-porting/figures/10ths_env2.png rename to documentation/3.kernel/kernel-porting/figures/10ths_env2.png diff --git a/documentation/kernel-porting/kernel-porting.md b/documentation/3.kernel/kernel-porting/kernel-porting.md similarity index 100% rename from documentation/kernel-porting/kernel-porting.md rename to documentation/3.kernel/kernel-porting/kernel-porting.md diff --git a/documentation/memory/figures/08Memory_distribution.png b/documentation/3.kernel/memory/figures/08Memory_distribution.png similarity index 100% rename from documentation/memory/figures/08Memory_distribution.png rename to documentation/3.kernel/memory/figures/08Memory_distribution.png diff --git a/documentation/memory/figures/08heap_ops.png b/documentation/3.kernel/memory/figures/08heap_ops.png similarity index 100% rename from documentation/memory/figures/08heap_ops.png rename to documentation/3.kernel/memory/figures/08heap_ops.png diff --git a/documentation/memory/figures/08memheap.png b/documentation/3.kernel/memory/figures/08memheap.png similarity index 100% rename from documentation/memory/figures/08memheap.png rename to documentation/3.kernel/memory/figures/08memheap.png diff --git a/documentation/memory/figures/08mempool.png b/documentation/3.kernel/memory/figures/08mempool.png similarity index 100% rename from documentation/memory/figures/08mempool.png rename to documentation/3.kernel/memory/figures/08mempool.png diff --git a/documentation/memory/figures/08mempool_ops.png b/documentation/3.kernel/memory/figures/08mempool_ops.png similarity index 100% rename from documentation/memory/figures/08mempool_ops.png rename to documentation/3.kernel/memory/figures/08mempool_ops.png diff --git a/documentation/memory/figures/08mempool_work.png b/documentation/3.kernel/memory/figures/08mempool_work.png similarity index 100% rename from documentation/memory/figures/08mempool_work.png rename to documentation/3.kernel/memory/figures/08mempool_work.png diff --git a/documentation/memory/figures/08slab.png b/documentation/3.kernel/memory/figures/08slab.png similarity index 100% rename from documentation/memory/figures/08slab.png rename to documentation/3.kernel/memory/figures/08slab.png diff --git a/documentation/memory/figures/08smem_work.png b/documentation/3.kernel/memory/figures/08smem_work.png similarity index 100% rename from documentation/memory/figures/08smem_work.png rename to documentation/3.kernel/memory/figures/08smem_work.png diff --git a/documentation/memory/figures/08smem_work2.png b/documentation/3.kernel/memory/figures/08smem_work2.png similarity index 100% rename from documentation/memory/figures/08smem_work2.png rename to documentation/3.kernel/memory/figures/08smem_work2.png diff --git a/documentation/memory/figures/08smem_work3.png b/documentation/3.kernel/memory/figures/08smem_work3.png similarity index 100% rename from documentation/memory/figures/08smem_work3.png rename to documentation/3.kernel/memory/figures/08smem_work3.png diff --git a/documentation/memory/figures/08smem_work4.png b/documentation/3.kernel/memory/figures/08smem_work4.png similarity index 100% rename from documentation/memory/figures/08smem_work4.png rename to documentation/3.kernel/memory/figures/08smem_work4.png diff --git a/documentation/memory/memory.md b/documentation/3.kernel/memory/memory.md similarity index 100% rename from documentation/memory/memory.md rename to documentation/3.kernel/memory/memory.md diff --git a/documentation/thread-comm/figures/07mb_ops.png b/documentation/3.kernel/thread-comm/figures/07mb_ops.png similarity index 100% rename from documentation/thread-comm/figures/07mb_ops.png rename to documentation/3.kernel/thread-comm/figures/07mb_ops.png diff --git a/documentation/thread-comm/figures/07mb_work.png b/documentation/3.kernel/thread-comm/figures/07mb_work.png similarity index 100% rename from documentation/thread-comm/figures/07mb_work.png rename to documentation/3.kernel/thread-comm/figures/07mb_work.png diff --git a/documentation/thread-comm/figures/07msg_ops.png b/documentation/3.kernel/thread-comm/figures/07msg_ops.png similarity index 100% rename from documentation/thread-comm/figures/07msg_ops.png rename to documentation/3.kernel/thread-comm/figures/07msg_ops.png diff --git a/documentation/thread-comm/figures/07msg_syn.png b/documentation/3.kernel/thread-comm/figures/07msg_syn.png similarity index 100% rename from documentation/thread-comm/figures/07msg_syn.png rename to documentation/3.kernel/thread-comm/figures/07msg_syn.png diff --git a/documentation/thread-comm/figures/07msg_work.png b/documentation/3.kernel/thread-comm/figures/07msg_work.png similarity index 100% rename from documentation/thread-comm/figures/07msg_work.png rename to documentation/3.kernel/thread-comm/figures/07msg_work.png diff --git a/documentation/thread-comm/figures/07signal_ops.png b/documentation/3.kernel/thread-comm/figures/07signal_ops.png similarity index 100% rename from documentation/thread-comm/figures/07signal_ops.png rename to documentation/3.kernel/thread-comm/figures/07signal_ops.png diff --git a/documentation/thread-comm/figures/07signal_work.png b/documentation/3.kernel/thread-comm/figures/07signal_work.png similarity index 100% rename from documentation/thread-comm/figures/07signal_work.png rename to documentation/3.kernel/thread-comm/figures/07signal_work.png diff --git a/documentation/thread-comm/thread-comm.md b/documentation/3.kernel/thread-comm/thread-comm.md similarity index 100% rename from documentation/thread-comm/thread-comm.md rename to documentation/3.kernel/thread-comm/thread-comm.md diff --git a/documentation/thread-sync/figures/06event_ops.png b/documentation/3.kernel/thread-sync/figures/06event_ops.png similarity index 100% rename from documentation/thread-sync/figures/06event_ops.png rename to documentation/3.kernel/thread-sync/figures/06event_ops.png diff --git a/documentation/thread-sync/figures/06event_use.png b/documentation/3.kernel/thread-sync/figures/06event_use.png similarity index 100% rename from documentation/thread-sync/figures/06event_use.png rename to documentation/3.kernel/thread-sync/figures/06event_use.png diff --git a/documentation/thread-sync/figures/06event_work.png b/documentation/3.kernel/thread-sync/figures/06event_work.png similarity index 100% rename from documentation/thread-sync/figures/06event_work.png rename to documentation/3.kernel/thread-sync/figures/06event_work.png diff --git a/documentation/thread-sync/figures/06inter_ths_commu1.png b/documentation/3.kernel/thread-sync/figures/06inter_ths_commu1.png similarity index 100% rename from documentation/thread-sync/figures/06inter_ths_commu1.png rename to documentation/3.kernel/thread-sync/figures/06inter_ths_commu1.png diff --git a/documentation/thread-sync/figures/06inter_ths_commu2.png b/documentation/3.kernel/thread-sync/figures/06inter_ths_commu2.png similarity index 100% rename from documentation/thread-sync/figures/06inter_ths_commu2.png rename to documentation/3.kernel/thread-sync/figures/06inter_ths_commu2.png diff --git a/documentation/thread-sync/figures/06mutex_ops.png b/documentation/3.kernel/thread-sync/figures/06mutex_ops.png similarity index 100% rename from documentation/thread-sync/figures/06mutex_ops.png rename to documentation/3.kernel/thread-sync/figures/06mutex_ops.png diff --git a/documentation/thread-sync/figures/06mutex_work.png b/documentation/3.kernel/thread-sync/figures/06mutex_work.png similarity index 100% rename from documentation/thread-sync/figures/06mutex_work.png rename to documentation/3.kernel/thread-sync/figures/06mutex_work.png diff --git a/documentation/thread-sync/figures/06priority_inherit.png b/documentation/3.kernel/thread-sync/figures/06priority_inherit.png similarity index 100% rename from documentation/thread-sync/figures/06priority_inherit.png rename to documentation/3.kernel/thread-sync/figures/06priority_inherit.png diff --git a/documentation/thread-sync/figures/06priority_inversion.png b/documentation/3.kernel/thread-sync/figures/06priority_inversion.png similarity index 100% rename from documentation/thread-sync/figures/06priority_inversion.png rename to documentation/3.kernel/thread-sync/figures/06priority_inversion.png diff --git a/documentation/thread-sync/figures/06sem_lock.png b/documentation/3.kernel/thread-sync/figures/06sem_lock.png similarity index 100% rename from documentation/thread-sync/figures/06sem_lock.png rename to documentation/3.kernel/thread-sync/figures/06sem_lock.png diff --git a/documentation/thread-sync/figures/06sem_ops.png b/documentation/3.kernel/thread-sync/figures/06sem_ops.png similarity index 100% rename from documentation/thread-sync/figures/06sem_ops.png rename to documentation/3.kernel/thread-sync/figures/06sem_ops.png diff --git a/documentation/thread-sync/figures/06sem_work.png b/documentation/3.kernel/thread-sync/figures/06sem_work.png similarity index 100% rename from documentation/thread-sync/figures/06sem_work.png rename to documentation/3.kernel/thread-sync/figures/06sem_work.png diff --git a/documentation/thread-sync/thread-sync.md b/documentation/3.kernel/thread-sync/thread-sync.md similarity index 100% rename from documentation/thread-sync/thread-sync.md rename to documentation/3.kernel/thread-sync/thread-sync.md diff --git a/documentation/thread/figures/04Object_container.png b/documentation/3.kernel/thread/figures/04Object_container.png similarity index 100% rename from documentation/thread/figures/04Object_container.png rename to documentation/3.kernel/thread/figures/04Object_container.png diff --git a/documentation/thread/figures/04Task_switching.png b/documentation/3.kernel/thread/figures/04Task_switching.png similarity index 100% rename from documentation/thread/figures/04Task_switching.png rename to documentation/3.kernel/thread/figures/04Task_switching.png diff --git a/documentation/thread/figures/04main_thread.png b/documentation/3.kernel/thread/figures/04main_thread.png similarity index 100% rename from documentation/thread/figures/04main_thread.png rename to documentation/3.kernel/thread/figures/04main_thread.png diff --git a/documentation/thread/figures/04thread_ops.png b/documentation/3.kernel/thread/figures/04thread_ops.png similarity index 100% rename from documentation/thread/figures/04thread_ops.png rename to documentation/3.kernel/thread/figures/04thread_ops.png diff --git a/documentation/thread/figures/04thread_sta.png b/documentation/3.kernel/thread/figures/04thread_sta.png similarity index 100% rename from documentation/thread/figures/04thread_sta.png rename to documentation/3.kernel/thread/figures/04thread_sta.png diff --git a/documentation/thread/figures/04thread_stack.png b/documentation/3.kernel/thread/figures/04thread_stack.png similarity index 100% rename from documentation/thread/figures/04thread_stack.png rename to documentation/3.kernel/thread/figures/04thread_stack.png diff --git a/documentation/thread/figures/04time_slience.png b/documentation/3.kernel/thread/figures/04time_slience.png similarity index 100% rename from documentation/thread/figures/04time_slience.png rename to documentation/3.kernel/thread/figures/04time_slience.png diff --git a/documentation/thread/thread.md b/documentation/3.kernel/thread/thread.md similarity index 100% rename from documentation/thread/thread.md rename to documentation/3.kernel/thread/thread.md diff --git a/documentation/timer/figures/05timer_env.png b/documentation/3.kernel/timer/figures/05timer_env.png similarity index 100% rename from documentation/timer/figures/05timer_env.png rename to documentation/3.kernel/timer/figures/05timer_env.png diff --git a/documentation/timer/figures/05timer_linked_list.png b/documentation/3.kernel/timer/figures/05timer_linked_list.png similarity index 100% rename from documentation/timer/figures/05timer_linked_list.png rename to documentation/3.kernel/timer/figures/05timer_linked_list.png diff --git a/documentation/timer/figures/05timer_linked_list2.png b/documentation/3.kernel/timer/figures/05timer_linked_list2.png similarity index 100% rename from documentation/timer/figures/05timer_linked_list2.png rename to documentation/3.kernel/timer/figures/05timer_linked_list2.png diff --git a/documentation/timer/figures/05timer_ops.png b/documentation/3.kernel/timer/figures/05timer_ops.png similarity index 100% rename from documentation/timer/figures/05timer_ops.png rename to documentation/3.kernel/timer/figures/05timer_ops.png diff --git a/documentation/timer/figures/05timer_skip_list.png b/documentation/3.kernel/timer/figures/05timer_skip_list.png similarity index 100% rename from documentation/timer/figures/05timer_skip_list.png rename to documentation/3.kernel/timer/figures/05timer_skip_list.png diff --git a/documentation/timer/figures/05timer_skip_list2.png b/documentation/3.kernel/timer/figures/05timer_skip_list2.png similarity index 100% rename from documentation/timer/figures/05timer_skip_list2.png rename to documentation/3.kernel/timer/figures/05timer_skip_list2.png diff --git a/documentation/timer/figures/05timer_skip_list3.png b/documentation/3.kernel/timer/figures/05timer_skip_list3.png similarity index 100% rename from documentation/timer/figures/05timer_skip_list3.png rename to documentation/3.kernel/timer/figures/05timer_skip_list3.png diff --git a/documentation/timer/timer.md b/documentation/3.kernel/timer/timer.md similarity index 100% rename from documentation/timer/timer.md rename to documentation/3.kernel/timer/timer.md diff --git a/documentation/scons/figures/hello-menu.png b/documentation/4.tool/scons/figures/hello-menu.png similarity index 100% rename from documentation/scons/figures/hello-menu.png rename to documentation/4.tool/scons/figures/hello-menu.png diff --git a/documentation/scons/figures/hello-rtconfig.png b/documentation/4.tool/scons/figures/hello-rtconfig.png similarity index 100% rename from documentation/scons/figures/hello-rtconfig.png rename to documentation/4.tool/scons/figures/hello-rtconfig.png diff --git a/documentation/scons/figures/hello-value.png b/documentation/4.tool/scons/figures/hello-value.png similarity index 100% rename from documentation/scons/figures/hello-value.png rename to documentation/4.tool/scons/figures/hello-value.png diff --git a/documentation/scons/figures/hello.png b/documentation/4.tool/scons/figures/hello.png similarity index 100% rename from documentation/scons/figures/hello.png rename to documentation/4.tool/scons/figures/hello.png diff --git a/documentation/scons/figures/kconfig.png b/documentation/4.tool/scons/figures/kconfig.png similarity index 100% rename from documentation/scons/figures/kconfig.png rename to documentation/4.tool/scons/figures/kconfig.png diff --git a/documentation/scons/figures/scons_compile.png b/documentation/4.tool/scons/figures/scons_compile.png similarity index 100% rename from documentation/scons/figures/scons_compile.png rename to documentation/4.tool/scons/figures/scons_compile.png diff --git a/documentation/scons/scons.md b/documentation/4.tool/scons/scons.md similarity index 100% rename from documentation/scons/scons.md rename to documentation/4.tool/scons/scons.md diff --git a/documentation/device/adc/adc.md b/documentation/5.device/adc/adc.md similarity index 100% rename from documentation/device/adc/adc.md rename to documentation/5.device/adc/adc.md diff --git a/documentation/device/adc/figures/adc-p.png b/documentation/5.device/adc/figures/adc-p.png similarity index 100% rename from documentation/device/adc/figures/adc-p.png rename to documentation/5.device/adc/figures/adc-p.png diff --git a/documentation/device/device.md b/documentation/5.device/framework/device.md similarity index 100% rename from documentation/device/device.md rename to documentation/5.device/framework/device.md diff --git a/documentation/device/figures/block-dev.png b/documentation/5.device/framework/figures/block-dev.png similarity index 100% rename from documentation/device/figures/block-dev.png rename to documentation/5.device/framework/figures/block-dev.png diff --git a/documentation/device/figures/io-call.png b/documentation/5.device/framework/figures/io-call.png similarity index 100% rename from documentation/device/figures/io-call.png rename to documentation/5.device/framework/figures/io-call.png diff --git a/documentation/device/figures/io-dev.png b/documentation/5.device/framework/figures/io-dev.png similarity index 100% rename from documentation/device/figures/io-dev.png rename to documentation/5.device/framework/figures/io-dev.png diff --git a/documentation/device/figures/io-fun-call.png b/documentation/5.device/framework/figures/io-fun-call.png similarity index 100% rename from documentation/device/figures/io-fun-call.png rename to documentation/5.device/framework/figures/io-fun-call.png diff --git a/documentation/device/figures/io-parent.png b/documentation/5.device/framework/figures/io-parent.png similarity index 100% rename from documentation/device/figures/io-parent.png rename to documentation/5.device/framework/figures/io-parent.png diff --git a/documentation/device/figures/wtd-uml.png b/documentation/5.device/framework/figures/wtd-uml.png similarity index 100% rename from documentation/device/figures/wtd-uml.png rename to documentation/5.device/framework/figures/wtd-uml.png diff --git a/documentation/device/hwtimer/hwtimer.md b/documentation/5.device/hwtimer/hwtimer.md similarity index 100% rename from documentation/device/hwtimer/hwtimer.md rename to documentation/5.device/hwtimer/hwtimer.md diff --git a/documentation/device/i2c/figures/i2c1.png b/documentation/5.device/i2c/figures/i2c1.png similarity index 100% rename from documentation/device/i2c/figures/i2c1.png rename to documentation/5.device/i2c/figures/i2c1.png diff --git a/documentation/device/i2c/figures/i2c2.png b/documentation/5.device/i2c/figures/i2c2.png similarity index 100% rename from documentation/device/i2c/figures/i2c2.png rename to documentation/5.device/i2c/figures/i2c2.png diff --git a/documentation/device/i2c/figures/i2c3.png b/documentation/5.device/i2c/figures/i2c3.png similarity index 100% rename from documentation/device/i2c/figures/i2c3.png rename to documentation/5.device/i2c/figures/i2c3.png diff --git a/documentation/device/i2c/i2c.md b/documentation/5.device/i2c/i2c.md similarity index 100% rename from documentation/device/i2c/i2c.md rename to documentation/5.device/i2c/i2c.md diff --git a/documentation/device/pin/figures/pin2.png b/documentation/5.device/pin/figures/pin2.png similarity index 100% rename from documentation/device/pin/figures/pin2.png rename to documentation/5.device/pin/figures/pin2.png diff --git a/documentation/device/pin/pin.md b/documentation/5.device/pin/pin.md similarity index 100% rename from documentation/device/pin/pin.md rename to documentation/5.device/pin/pin.md diff --git a/documentation/device/pwm/figures/pwm-f.png b/documentation/5.device/pwm/figures/pwm-f.png similarity index 100% rename from documentation/device/pwm/figures/pwm-f.png rename to documentation/5.device/pwm/figures/pwm-f.png diff --git a/documentation/device/pwm/figures/pwm-l.png b/documentation/5.device/pwm/figures/pwm-l.png similarity index 100% rename from documentation/device/pwm/figures/pwm-l.png rename to documentation/5.device/pwm/figures/pwm-l.png diff --git a/documentation/device/pwm/pwm.md b/documentation/5.device/pwm/pwm.md similarity index 100% rename from documentation/device/pwm/pwm.md rename to documentation/5.device/pwm/pwm.md diff --git a/documentation/device/rtc/rtc.md b/documentation/5.device/rtc/rtc.md similarity index 100% rename from documentation/device/rtc/rtc.md rename to documentation/5.device/rtc/rtc.md diff --git a/documentation/device/sensor/sensor.md b/documentation/5.device/sensor/sensor.md similarity index 100% rename from documentation/device/sensor/sensor.md rename to documentation/5.device/sensor/sensor.md diff --git a/documentation/device/spi/figures/spi1.png b/documentation/5.device/spi/figures/spi1.png similarity index 100% rename from documentation/device/spi/figures/spi1.png rename to documentation/5.device/spi/figures/spi1.png diff --git a/documentation/device/spi/figures/spi2.png b/documentation/5.device/spi/figures/spi2.png similarity index 100% rename from documentation/device/spi/figures/spi2.png rename to documentation/5.device/spi/figures/spi2.png diff --git a/documentation/device/spi/figures/spi5.png b/documentation/5.device/spi/figures/spi5.png similarity index 100% rename from documentation/device/spi/figures/spi5.png rename to documentation/5.device/spi/figures/spi5.png diff --git a/documentation/device/spi/spi.md b/documentation/5.device/spi/spi.md similarity index 100% rename from documentation/device/spi/spi.md rename to documentation/5.device/spi/spi.md diff --git a/documentation/device/uart/figures/uart-dma.png b/documentation/5.device/uart/figures/uart-dma.png similarity index 100% rename from documentation/device/uart/figures/uart-dma.png rename to documentation/5.device/uart/figures/uart-dma.png diff --git a/documentation/device/uart/figures/uart-int.png b/documentation/5.device/uart/figures/uart-int.png similarity index 100% rename from documentation/device/uart/figures/uart-int.png rename to documentation/5.device/uart/figures/uart-int.png diff --git a/documentation/device/uart/figures/uart1.png b/documentation/5.device/uart/figures/uart1.png similarity index 100% rename from documentation/device/uart/figures/uart1.png rename to documentation/5.device/uart/figures/uart1.png diff --git a/documentation/device/uart/uart.md b/documentation/5.device/uart/uart.md similarity index 100% rename from documentation/device/uart/uart.md rename to documentation/5.device/uart/uart.md diff --git a/documentation/device/watchdog/watchdog.md b/documentation/5.device/watchdog/watchdog.md similarity index 100% rename from documentation/device/watchdog/watchdog.md rename to documentation/5.device/watchdog/watchdog.md diff --git a/documentation/device/wlan/figures/an0026_1.png b/documentation/5.device/wlan/figures/an0026_1.png similarity index 100% rename from documentation/device/wlan/figures/an0026_1.png rename to documentation/5.device/wlan/figures/an0026_1.png diff --git a/documentation/device/wlan/figures/an0026_3.png b/documentation/5.device/wlan/figures/an0026_3.png similarity index 100% rename from documentation/device/wlan/figures/an0026_3.png rename to documentation/5.device/wlan/figures/an0026_3.png diff --git a/documentation/device/wlan/figures/an0026_4.png b/documentation/5.device/wlan/figures/an0026_4.png similarity index 100% rename from documentation/device/wlan/figures/an0026_4.png rename to documentation/5.device/wlan/figures/an0026_4.png diff --git a/documentation/device/wlan/figures/an0026_5.png b/documentation/5.device/wlan/figures/an0026_5.png similarity index 100% rename from documentation/device/wlan/figures/an0026_5.png rename to documentation/5.device/wlan/figures/an0026_5.png diff --git a/documentation/device/wlan/wlan.md b/documentation/5.device/wlan/wlan.md similarity index 100% rename from documentation/device/wlan/wlan.md rename to documentation/5.device/wlan/wlan.md diff --git a/documentation/at/at.md b/documentation/6.components/at/at.md similarity index 100% rename from documentation/at/at.md rename to documentation/6.components/at/at.md diff --git a/documentation/at/figures/at_framework.jpg b/documentation/6.components/at/figures/at_framework.jpg similarity index 100% rename from documentation/at/figures/at_framework.jpg rename to documentation/6.components/at/figures/at_framework.jpg diff --git a/documentation/at/figures/at_multiple_client.jpg b/documentation/6.components/at/figures/at_multiple_client.jpg similarity index 100% rename from documentation/at/figures/at_multiple_client.jpg rename to documentation/6.components/at/figures/at_multiple_client.jpg diff --git a/documentation/dlmodule/README.md b/documentation/6.components/dlmodule/README.md similarity index 100% rename from documentation/dlmodule/README.md rename to documentation/6.components/dlmodule/README.md diff --git a/documentation/filesystem/README.md b/documentation/6.components/filesystem/README.md similarity index 100% rename from documentation/filesystem/README.md rename to documentation/6.components/filesystem/README.md diff --git a/documentation/filesystem/figures/elm-fat-mkfs.png b/documentation/6.components/filesystem/figures/elm-fat-mkfs.png similarity index 100% rename from documentation/filesystem/figures/elm-fat-mkfs.png rename to documentation/6.components/filesystem/figures/elm-fat-mkfs.png diff --git a/documentation/filesystem/figures/fs-dir-mg.png b/documentation/6.components/filesystem/figures/fs-dir-mg.png similarity index 100% rename from documentation/filesystem/figures/fs-dir-mg.png rename to documentation/6.components/filesystem/figures/fs-dir-mg.png diff --git a/documentation/filesystem/figures/fs-dir.png b/documentation/6.components/filesystem/figures/fs-dir.png similarity index 100% rename from documentation/filesystem/figures/fs-dir.png rename to documentation/6.components/filesystem/figures/fs-dir.png diff --git a/documentation/filesystem/figures/fs-layer.png b/documentation/6.components/filesystem/figures/fs-layer.png similarity index 100% rename from documentation/filesystem/figures/fs-layer.png rename to documentation/6.components/filesystem/figures/fs-layer.png diff --git a/documentation/filesystem/figures/fs-mg.png b/documentation/6.components/filesystem/figures/fs-mg.png similarity index 100% rename from documentation/filesystem/figures/fs-mg.png rename to documentation/6.components/filesystem/figures/fs-mg.png diff --git a/documentation/filesystem/figures/fs-reg-block.png b/documentation/6.components/filesystem/figures/fs-reg-block.png similarity index 100% rename from documentation/filesystem/figures/fs-reg-block.png rename to documentation/6.components/filesystem/figures/fs-reg-block.png diff --git a/documentation/filesystem/figures/fs-reg.png b/documentation/6.components/filesystem/figures/fs-reg.png similarity index 100% rename from documentation/filesystem/figures/fs-reg.png rename to documentation/6.components/filesystem/figures/fs-reg.png diff --git a/documentation/finsh/figures/finsh-hd.png b/documentation/6.components/finsh/figures/finsh-hd.png similarity index 100% rename from documentation/finsh/figures/finsh-hd.png rename to documentation/6.components/finsh/figures/finsh-hd.png diff --git a/documentation/finsh/figures/finsh-mdk.png b/documentation/6.components/finsh/figures/finsh-mdk.png similarity index 100% rename from documentation/finsh/figures/finsh-mdk.png rename to documentation/6.components/finsh/figures/finsh-mdk.png diff --git a/documentation/finsh/figures/finsh-run.png b/documentation/6.components/finsh/figures/finsh-run.png similarity index 100% rename from documentation/finsh/figures/finsh-run.png rename to documentation/6.components/finsh/figures/finsh-run.png diff --git a/documentation/finsh/finsh.md b/documentation/6.components/finsh/finsh.md similarity index 100% rename from documentation/finsh/finsh.md rename to documentation/6.components/finsh/finsh.md diff --git a/documentation/network/figures/net-hello.png b/documentation/6.components/network/figures/net-hello.png similarity index 100% rename from documentation/network/figures/net-hello.png rename to documentation/6.components/network/figures/net-hello.png diff --git a/documentation/network/figures/net-layer.png b/documentation/6.components/network/figures/net-layer.png similarity index 100% rename from documentation/network/figures/net-layer.png rename to documentation/6.components/network/figures/net-layer.png diff --git a/documentation/network/figures/net-osi.png b/documentation/6.components/network/figures/net-osi.png similarity index 100% rename from documentation/network/figures/net-osi.png rename to documentation/6.components/network/figures/net-osi.png diff --git a/documentation/network/figures/net-recv.png b/documentation/6.components/network/figures/net-recv.png similarity index 100% rename from documentation/network/figures/net-recv.png rename to documentation/6.components/network/figures/net-recv.png diff --git a/documentation/network/figures/net-send.png b/documentation/6.components/network/figures/net-send.png similarity index 100% rename from documentation/network/figures/net-send.png rename to documentation/6.components/network/figures/net-send.png diff --git a/documentation/network/figures/net-tcp-s.png b/documentation/6.components/network/figures/net-tcp-s.png similarity index 100% rename from documentation/network/figures/net-tcp-s.png rename to documentation/6.components/network/figures/net-tcp-s.png diff --git a/documentation/network/figures/net-tcp.png b/documentation/6.components/network/figures/net-tcp.png similarity index 100% rename from documentation/network/figures/net-tcp.png rename to documentation/6.components/network/figures/net-tcp.png diff --git a/documentation/network/figures/net-udp-client.png b/documentation/6.components/network/figures/net-udp-client.png similarity index 100% rename from documentation/network/figures/net-udp-client.png rename to documentation/6.components/network/figures/net-udp-client.png diff --git a/documentation/network/figures/net-udp-server.png b/documentation/6.components/network/figures/net-udp-server.png similarity index 100% rename from documentation/network/figures/net-udp-server.png rename to documentation/6.components/network/figures/net-udp-server.png diff --git a/documentation/network/figures/net-udp.png b/documentation/6.components/network/figures/net-udp.png similarity index 100% rename from documentation/network/figures/net-udp.png rename to documentation/6.components/network/figures/net-udp.png diff --git a/documentation/network/network.md b/documentation/6.components/network/network.md similarity index 100% rename from documentation/network/network.md rename to documentation/6.components/network/network.md diff --git a/documentation/pm/figures/pm_architecture.png b/documentation/6.components/pm/figures/pm_architecture.png similarity index 100% rename from documentation/pm/figures/pm_architecture.png rename to documentation/6.components/pm/figures/pm_architecture.png diff --git a/documentation/pm/figures/pm_description.png b/documentation/6.components/pm/figures/pm_description.png similarity index 100% rename from documentation/pm/figures/pm_description.png rename to documentation/6.components/pm/figures/pm_description.png diff --git a/documentation/pm/figures/pm_sequence.png b/documentation/6.components/pm/figures/pm_sequence.png similarity index 100% rename from documentation/pm/figures/pm_sequence.png rename to documentation/6.components/pm/figures/pm_sequence.png diff --git a/documentation/pm/figures/pm_system.png b/documentation/6.components/pm/figures/pm_system.png similarity index 100% rename from documentation/pm/figures/pm_system.png rename to documentation/6.components/pm/figures/pm_system.png diff --git a/documentation/pm/pm.md b/documentation/6.components/pm/pm.md similarity index 100% rename from documentation/pm/pm.md rename to documentation/6.components/pm/pm.md diff --git a/documentation/posix/README.md b/documentation/6.components/posix/README.md similarity index 100% rename from documentation/posix/README.md rename to documentation/6.components/posix/README.md diff --git a/documentation/sal/figures/sal_frame.jpg b/documentation/6.components/sal/figures/sal_frame.jpg similarity index 100% rename from documentation/sal/figures/sal_frame.jpg rename to documentation/6.components/sal/figures/sal_frame.jpg diff --git a/documentation/sal/sal.md b/documentation/6.components/sal/sal.md similarity index 100% rename from documentation/sal/sal.md rename to documentation/6.components/sal/sal.md diff --git a/documentation/ulog/figures/ulog_async_vs_sync.png b/documentation/6.components/ulog/figures/ulog_async_vs_sync.png similarity index 100% rename from documentation/ulog/figures/ulog_async_vs_sync.png rename to documentation/6.components/ulog/figures/ulog_async_vs_sync.png diff --git a/documentation/ulog/figures/ulog_example.png b/documentation/6.components/ulog/figures/ulog_example.png similarity index 100% rename from documentation/ulog/figures/ulog_example.png rename to documentation/6.components/ulog/figures/ulog_example.png diff --git a/documentation/ulog/figures/ulog_example_all_format.png b/documentation/6.components/ulog/figures/ulog_example_all_format.png similarity index 100% rename from documentation/ulog/figures/ulog_example_all_format.png rename to documentation/6.components/ulog/figures/ulog_example_all_format.png diff --git a/documentation/ulog/figures/ulog_example_async.png b/documentation/6.components/ulog/figures/ulog_example_async.png similarity index 100% rename from documentation/ulog/figures/ulog_example_async.png rename to documentation/6.components/ulog/figures/ulog_example_async.png diff --git a/documentation/ulog/figures/ulog_example_filter20.png b/documentation/6.components/ulog/figures/ulog_example_filter20.png similarity index 100% rename from documentation/ulog/figures/ulog_example_filter20.png rename to documentation/6.components/ulog/figures/ulog_example_filter20.png diff --git a/documentation/ulog/figures/ulog_example_filter30.png b/documentation/6.components/ulog/figures/ulog_example_filter30.png similarity index 100% rename from documentation/ulog/figures/ulog_example_filter30.png rename to documentation/6.components/ulog/figures/ulog_example_filter30.png diff --git a/documentation/ulog/figures/ulog_example_filter40.png b/documentation/6.components/ulog/figures/ulog_example_filter40.png similarity index 100% rename from documentation/ulog/figures/ulog_example_filter40.png rename to documentation/6.components/ulog/figures/ulog_example_filter40.png diff --git a/documentation/ulog/figures/ulog_example_hexdump.png b/documentation/6.components/ulog/figures/ulog_example_hexdump.png similarity index 100% rename from documentation/ulog/figures/ulog_example_hexdump.png rename to documentation/6.components/ulog/figures/ulog_example_hexdump.png diff --git a/documentation/ulog/figures/ulog_example_syslog.png b/documentation/6.components/ulog/figures/ulog_example_syslog.png similarity index 100% rename from documentation/ulog/figures/ulog_example_syslog.png rename to documentation/6.components/ulog/figures/ulog_example_syslog.png diff --git a/documentation/ulog/figures/ulog_framework.png b/documentation/6.components/ulog/figures/ulog_framework.png similarity index 100% rename from documentation/ulog/figures/ulog_framework.png rename to documentation/6.components/ulog/figures/ulog_framework.png diff --git a/documentation/ulog/figures/ulog_framework_backend.png b/documentation/6.components/ulog/figures/ulog_framework_backend.png similarity index 100% rename from documentation/ulog/figures/ulog_framework_backend.png rename to documentation/6.components/ulog/figures/ulog_framework_backend.png diff --git a/documentation/ulog/figures/ulog_menuconfig_async.png b/documentation/6.components/ulog/figures/ulog_menuconfig_async.png similarity index 100% rename from documentation/ulog/figures/ulog_menuconfig_async.png rename to documentation/6.components/ulog/figures/ulog_menuconfig_async.png diff --git a/documentation/ulog/figures/ulog_menuconfig_format.png b/documentation/6.components/ulog/figures/ulog_menuconfig_format.png similarity index 100% rename from documentation/ulog/figures/ulog_menuconfig_format.png rename to documentation/6.components/ulog/figures/ulog_menuconfig_format.png diff --git a/documentation/ulog/figures/ulog_syslog_format.png b/documentation/6.components/ulog/figures/ulog_syslog_format.png similarity index 100% rename from documentation/ulog/figures/ulog_syslog_format.png rename to documentation/6.components/ulog/figures/ulog_syslog_format.png diff --git a/documentation/ulog/ulog.md b/documentation/6.components/ulog/ulog.md similarity index 100% rename from documentation/ulog/ulog.md rename to documentation/6.components/ulog/ulog.md diff --git a/documentation/utest/figures/UtestAppStruct-1.png b/documentation/6.components/utest/figures/UtestAppStruct-1.png similarity index 100% rename from documentation/utest/figures/UtestAppStruct-1.png rename to documentation/6.components/utest/figures/UtestAppStruct-1.png diff --git a/documentation/utest/figures/UtestRunLogShow.png b/documentation/6.components/utest/figures/UtestRunLogShow.png similarity index 100% rename from documentation/utest/figures/UtestRunLogShow.png rename to documentation/6.components/utest/figures/UtestRunLogShow.png diff --git a/documentation/utest/figures/testcase-runflowchart.jpg b/documentation/6.components/utest/figures/testcase-runflowchart.jpg similarity index 100% rename from documentation/utest/figures/testcase-runflowchart.jpg rename to documentation/6.components/utest/figures/testcase-runflowchart.jpg diff --git a/documentation/utest/utest.md b/documentation/6.components/utest/utest.md similarity index 100% rename from documentation/utest/utest.md rename to documentation/6.components/utest/utest.md diff --git a/documentation/contribution_guide/coding_style_cn.md b/documentation/7.contribution/coding_style_cn.md similarity index 100% rename from documentation/contribution_guide/coding_style_cn.md rename to documentation/7.contribution/coding_style_cn.md diff --git a/documentation/contribution_guide/coding_style_en.md b/documentation/7.contribution/coding_style_en.md similarity index 100% rename from documentation/contribution_guide/coding_style_en.md rename to documentation/7.contribution/coding_style_en.md diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 7fbdaa62da4..21699688eb1 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -923,7 +923,7 @@ RECURSIVE = YES EXCLUDE = ./0.doxygen/mainpage.h \ ./2.quick-start/quick_start_qemu \ ./env/env-vscode.md \ - ./contribution_guide/coding_style_cn.md + ./7.contribution/coding_style_cn.md # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded