Browse Source

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 <unicorn_wang@outlook.com>
Chen Wang 2 months ago
parent
commit
75722c4998
100 changed files with 2 additions and 2 deletions
  1. 1 1
      .gitee/PULL_REQUEST_TEMPLATE.en.md
  2. 1 1
      .gitee/PULL_REQUEST_TEMPLATE.zh-CN.md
  3. 0 0
      documentation/3.kernel/basic/basic.md
  4. 0 0
      documentation/3.kernel/basic/figures/03Memory_distribution.png
  5. 0 0
      documentation/3.kernel/basic/figures/03Startup_process.png
  6. 0 0
      documentation/3.kernel/basic/figures/03kernel_Framework.png
  7. 0 0
      documentation/3.kernel/basic/figures/03kernel_object.png
  8. 0 0
      documentation/3.kernel/basic/figures/03kernel_object2.png
  9. 0 0
      documentation/3.kernel/interrupt/figures/09fun1.png
  10. 0 0
      documentation/3.kernel/interrupt/figures/09fun2.png
  11. 0 0
      documentation/3.kernel/interrupt/figures/09interrupt_handle.png
  12. 0 0
      documentation/3.kernel/interrupt/figures/09interrupt_ops.png
  13. 0 0
      documentation/3.kernel/interrupt/figures/09interrupt_reque.png
  14. 0 0
      documentation/3.kernel/interrupt/figures/09interrupt_table.png
  15. 0 0
      documentation/3.kernel/interrupt/figures/09interrupt_work.png
  16. 0 0
      documentation/3.kernel/interrupt/figures/09interrupt_work_process.png
  17. 0 0
      documentation/3.kernel/interrupt/figures/09interrupt_work_sta.png
  18. 0 0
      documentation/3.kernel/interrupt/figures/09relation.png
  19. 0 0
      documentation/3.kernel/interrupt/figures/09ths_switch.png
  20. 0 0
      documentation/3.kernel/interrupt/interrupt.md
  21. 0 0
      documentation/3.kernel/kernel-porting/figures/10pendsv.png
  22. 0 0
      documentation/3.kernel/kernel-porting/figures/10stack.png
  23. 0 0
      documentation/3.kernel/kernel-porting/figures/10switch.png
  24. 0 0
      documentation/3.kernel/kernel-porting/figures/10switch2.png
  25. 0 0
      documentation/3.kernel/kernel-porting/figures/10ths_env1.png
  26. 0 0
      documentation/3.kernel/kernel-porting/figures/10ths_env2.png
  27. 0 0
      documentation/3.kernel/kernel-porting/kernel-porting.md
  28. 0 0
      documentation/3.kernel/memory/figures/08Memory_distribution.png
  29. 0 0
      documentation/3.kernel/memory/figures/08heap_ops.png
  30. 0 0
      documentation/3.kernel/memory/figures/08memheap.png
  31. 0 0
      documentation/3.kernel/memory/figures/08mempool.png
  32. 0 0
      documentation/3.kernel/memory/figures/08mempool_ops.png
  33. 0 0
      documentation/3.kernel/memory/figures/08mempool_work.png
  34. 0 0
      documentation/3.kernel/memory/figures/08slab.png
  35. 0 0
      documentation/3.kernel/memory/figures/08smem_work.png
  36. 0 0
      documentation/3.kernel/memory/figures/08smem_work2.png
  37. 0 0
      documentation/3.kernel/memory/figures/08smem_work3.png
  38. 0 0
      documentation/3.kernel/memory/figures/08smem_work4.png
  39. 0 0
      documentation/3.kernel/memory/memory.md
  40. 0 0
      documentation/3.kernel/thread-comm/figures/07mb_ops.png
  41. 0 0
      documentation/3.kernel/thread-comm/figures/07mb_work.png
  42. 0 0
      documentation/3.kernel/thread-comm/figures/07msg_ops.png
  43. 0 0
      documentation/3.kernel/thread-comm/figures/07msg_syn.png
  44. 0 0
      documentation/3.kernel/thread-comm/figures/07msg_work.png
  45. 0 0
      documentation/3.kernel/thread-comm/figures/07signal_ops.png
  46. 0 0
      documentation/3.kernel/thread-comm/figures/07signal_work.png
  47. 0 0
      documentation/3.kernel/thread-comm/thread-comm.md
  48. 0 0
      documentation/3.kernel/thread-sync/figures/06event_ops.png
  49. 0 0
      documentation/3.kernel/thread-sync/figures/06event_use.png
  50. 0 0
      documentation/3.kernel/thread-sync/figures/06event_work.png
  51. 0 0
      documentation/3.kernel/thread-sync/figures/06inter_ths_commu1.png
  52. 0 0
      documentation/3.kernel/thread-sync/figures/06inter_ths_commu2.png
  53. 0 0
      documentation/3.kernel/thread-sync/figures/06mutex_ops.png
  54. 0 0
      documentation/3.kernel/thread-sync/figures/06mutex_work.png
  55. 0 0
      documentation/3.kernel/thread-sync/figures/06priority_inherit.png
  56. 0 0
      documentation/3.kernel/thread-sync/figures/06priority_inversion.png
  57. 0 0
      documentation/3.kernel/thread-sync/figures/06sem_lock.png
  58. 0 0
      documentation/3.kernel/thread-sync/figures/06sem_ops.png
  59. 0 0
      documentation/3.kernel/thread-sync/figures/06sem_work.png
  60. 0 0
      documentation/3.kernel/thread-sync/thread-sync.md
  61. 0 0
      documentation/3.kernel/thread/figures/04Object_container.png
  62. 0 0
      documentation/3.kernel/thread/figures/04Task_switching.png
  63. 0 0
      documentation/3.kernel/thread/figures/04main_thread.png
  64. 0 0
      documentation/3.kernel/thread/figures/04thread_ops.png
  65. 0 0
      documentation/3.kernel/thread/figures/04thread_sta.png
  66. 0 0
      documentation/3.kernel/thread/figures/04thread_stack.png
  67. 0 0
      documentation/3.kernel/thread/figures/04time_slience.png
  68. 0 0
      documentation/3.kernel/thread/thread.md
  69. 0 0
      documentation/3.kernel/timer/figures/05timer_env.png
  70. 0 0
      documentation/3.kernel/timer/figures/05timer_linked_list.png
  71. 0 0
      documentation/3.kernel/timer/figures/05timer_linked_list2.png
  72. 0 0
      documentation/3.kernel/timer/figures/05timer_ops.png
  73. 0 0
      documentation/3.kernel/timer/figures/05timer_skip_list.png
  74. 0 0
      documentation/3.kernel/timer/figures/05timer_skip_list2.png
  75. 0 0
      documentation/3.kernel/timer/figures/05timer_skip_list3.png
  76. 0 0
      documentation/3.kernel/timer/timer.md
  77. 0 0
      documentation/4.tool/scons/figures/hello-menu.png
  78. 0 0
      documentation/4.tool/scons/figures/hello-rtconfig.png
  79. 0 0
      documentation/4.tool/scons/figures/hello-value.png
  80. 0 0
      documentation/4.tool/scons/figures/hello.png
  81. 0 0
      documentation/4.tool/scons/figures/kconfig.png
  82. 0 0
      documentation/4.tool/scons/figures/scons_compile.png
  83. 0 0
      documentation/4.tool/scons/scons.md
  84. 0 0
      documentation/5.device/adc/adc.md
  85. 0 0
      documentation/5.device/adc/figures/adc-p.png
  86. 0 0
      documentation/5.device/framework/device.md
  87. 0 0
      documentation/5.device/framework/figures/block-dev.png
  88. 0 0
      documentation/5.device/framework/figures/io-call.png
  89. 0 0
      documentation/5.device/framework/figures/io-dev.png
  90. 0 0
      documentation/5.device/framework/figures/io-fun-call.png
  91. 0 0
      documentation/5.device/framework/figures/io-parent.png
  92. 0 0
      documentation/5.device/framework/figures/wtd-uml.png
  93. 0 0
      documentation/5.device/hwtimer/hwtimer.md
  94. 0 0
      documentation/5.device/i2c/figures/i2c1.png
  95. 0 0
      documentation/5.device/i2c/figures/i2c2.png
  96. 0 0
      documentation/5.device/i2c/figures/i2c3.png
  97. 0 0
      documentation/5.device/i2c/i2c.md
  98. 0 0
      documentation/5.device/pin/figures/pin2.png
  99. 0 0
      documentation/5.device/pin/pin.md
  100. 0 0
      documentation/5.device/pwm/figures/pwm-f.png

+ 1 - 1
.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)

+ 1 - 1
.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)

+ 0 - 0
documentation/basic/basic.md → documentation/3.kernel/basic/basic.md


+ 0 - 0
documentation/basic/figures/03Memory_distribution.png → documentation/3.kernel/basic/figures/03Memory_distribution.png


+ 0 - 0
documentation/basic/figures/03Startup_process.png → documentation/3.kernel/basic/figures/03Startup_process.png


+ 0 - 0
documentation/basic/figures/03kernel_Framework.png → documentation/3.kernel/basic/figures/03kernel_Framework.png


+ 0 - 0
documentation/basic/figures/03kernel_object.png → documentation/3.kernel/basic/figures/03kernel_object.png


+ 0 - 0
documentation/basic/figures/03kernel_object2.png → documentation/3.kernel/basic/figures/03kernel_object2.png


+ 0 - 0
documentation/interrupt/figures/09fun1.png → documentation/3.kernel/interrupt/figures/09fun1.png


+ 0 - 0
documentation/interrupt/figures/09fun2.png → documentation/3.kernel/interrupt/figures/09fun2.png


+ 0 - 0
documentation/interrupt/figures/09interrupt_handle.png → documentation/3.kernel/interrupt/figures/09interrupt_handle.png


+ 0 - 0
documentation/interrupt/figures/09interrupt_ops.png → documentation/3.kernel/interrupt/figures/09interrupt_ops.png


+ 0 - 0
documentation/interrupt/figures/09interrupt_reque.png → documentation/3.kernel/interrupt/figures/09interrupt_reque.png


+ 0 - 0
documentation/interrupt/figures/09interrupt_table.png → documentation/3.kernel/interrupt/figures/09interrupt_table.png


+ 0 - 0
documentation/interrupt/figures/09interrupt_work.png → documentation/3.kernel/interrupt/figures/09interrupt_work.png


+ 0 - 0
documentation/interrupt/figures/09interrupt_work_process.png → documentation/3.kernel/interrupt/figures/09interrupt_work_process.png


+ 0 - 0
documentation/interrupt/figures/09interrupt_work_sta.png → documentation/3.kernel/interrupt/figures/09interrupt_work_sta.png


+ 0 - 0
documentation/interrupt/figures/09relation.png → documentation/3.kernel/interrupt/figures/09relation.png


+ 0 - 0
documentation/interrupt/figures/09ths_switch.png → documentation/3.kernel/interrupt/figures/09ths_switch.png


+ 0 - 0
documentation/interrupt/interrupt.md → documentation/3.kernel/interrupt/interrupt.md


+ 0 - 0
documentation/kernel-porting/figures/10pendsv.png → documentation/3.kernel/kernel-porting/figures/10pendsv.png


+ 0 - 0
documentation/kernel-porting/figures/10stack.png → documentation/3.kernel/kernel-porting/figures/10stack.png


+ 0 - 0
documentation/kernel-porting/figures/10switch.png → documentation/3.kernel/kernel-porting/figures/10switch.png


+ 0 - 0
documentation/kernel-porting/figures/10switch2.png → documentation/3.kernel/kernel-porting/figures/10switch2.png


+ 0 - 0
documentation/kernel-porting/figures/10ths_env1.png → documentation/3.kernel/kernel-porting/figures/10ths_env1.png


+ 0 - 0
documentation/kernel-porting/figures/10ths_env2.png → documentation/3.kernel/kernel-porting/figures/10ths_env2.png


+ 0 - 0
documentation/kernel-porting/kernel-porting.md → documentation/3.kernel/kernel-porting/kernel-porting.md


+ 0 - 0
documentation/memory/figures/08Memory_distribution.png → documentation/3.kernel/memory/figures/08Memory_distribution.png


+ 0 - 0
documentation/memory/figures/08heap_ops.png → documentation/3.kernel/memory/figures/08heap_ops.png


+ 0 - 0
documentation/memory/figures/08memheap.png → documentation/3.kernel/memory/figures/08memheap.png


+ 0 - 0
documentation/memory/figures/08mempool.png → documentation/3.kernel/memory/figures/08mempool.png


+ 0 - 0
documentation/memory/figures/08mempool_ops.png → documentation/3.kernel/memory/figures/08mempool_ops.png


+ 0 - 0
documentation/memory/figures/08mempool_work.png → documentation/3.kernel/memory/figures/08mempool_work.png


+ 0 - 0
documentation/memory/figures/08slab.png → documentation/3.kernel/memory/figures/08slab.png


+ 0 - 0
documentation/memory/figures/08smem_work.png → documentation/3.kernel/memory/figures/08smem_work.png


+ 0 - 0
documentation/memory/figures/08smem_work2.png → documentation/3.kernel/memory/figures/08smem_work2.png


+ 0 - 0
documentation/memory/figures/08smem_work3.png → documentation/3.kernel/memory/figures/08smem_work3.png


+ 0 - 0
documentation/memory/figures/08smem_work4.png → documentation/3.kernel/memory/figures/08smem_work4.png


+ 0 - 0
documentation/memory/memory.md → documentation/3.kernel/memory/memory.md


+ 0 - 0
documentation/thread-comm/figures/07mb_ops.png → documentation/3.kernel/thread-comm/figures/07mb_ops.png


+ 0 - 0
documentation/thread-comm/figures/07mb_work.png → documentation/3.kernel/thread-comm/figures/07mb_work.png


+ 0 - 0
documentation/thread-comm/figures/07msg_ops.png → documentation/3.kernel/thread-comm/figures/07msg_ops.png


+ 0 - 0
documentation/thread-comm/figures/07msg_syn.png → documentation/3.kernel/thread-comm/figures/07msg_syn.png


+ 0 - 0
documentation/thread-comm/figures/07msg_work.png → documentation/3.kernel/thread-comm/figures/07msg_work.png


+ 0 - 0
documentation/thread-comm/figures/07signal_ops.png → documentation/3.kernel/thread-comm/figures/07signal_ops.png


+ 0 - 0
documentation/thread-comm/figures/07signal_work.png → documentation/3.kernel/thread-comm/figures/07signal_work.png


+ 0 - 0
documentation/thread-comm/thread-comm.md → documentation/3.kernel/thread-comm/thread-comm.md


+ 0 - 0
documentation/thread-sync/figures/06event_ops.png → documentation/3.kernel/thread-sync/figures/06event_ops.png


+ 0 - 0
documentation/thread-sync/figures/06event_use.png → documentation/3.kernel/thread-sync/figures/06event_use.png


+ 0 - 0
documentation/thread-sync/figures/06event_work.png → documentation/3.kernel/thread-sync/figures/06event_work.png


+ 0 - 0
documentation/thread-sync/figures/06inter_ths_commu1.png → documentation/3.kernel/thread-sync/figures/06inter_ths_commu1.png


+ 0 - 0
documentation/thread-sync/figures/06inter_ths_commu2.png → documentation/3.kernel/thread-sync/figures/06inter_ths_commu2.png


+ 0 - 0
documentation/thread-sync/figures/06mutex_ops.png → documentation/3.kernel/thread-sync/figures/06mutex_ops.png


+ 0 - 0
documentation/thread-sync/figures/06mutex_work.png → documentation/3.kernel/thread-sync/figures/06mutex_work.png


+ 0 - 0
documentation/thread-sync/figures/06priority_inherit.png → documentation/3.kernel/thread-sync/figures/06priority_inherit.png


+ 0 - 0
documentation/thread-sync/figures/06priority_inversion.png → documentation/3.kernel/thread-sync/figures/06priority_inversion.png


+ 0 - 0
documentation/thread-sync/figures/06sem_lock.png → documentation/3.kernel/thread-sync/figures/06sem_lock.png


+ 0 - 0
documentation/thread-sync/figures/06sem_ops.png → documentation/3.kernel/thread-sync/figures/06sem_ops.png


+ 0 - 0
documentation/thread-sync/figures/06sem_work.png → documentation/3.kernel/thread-sync/figures/06sem_work.png


+ 0 - 0
documentation/thread-sync/thread-sync.md → documentation/3.kernel/thread-sync/thread-sync.md


+ 0 - 0
documentation/thread/figures/04Object_container.png → documentation/3.kernel/thread/figures/04Object_container.png


+ 0 - 0
documentation/thread/figures/04Task_switching.png → documentation/3.kernel/thread/figures/04Task_switching.png


+ 0 - 0
documentation/thread/figures/04main_thread.png → documentation/3.kernel/thread/figures/04main_thread.png


+ 0 - 0
documentation/thread/figures/04thread_ops.png → documentation/3.kernel/thread/figures/04thread_ops.png


+ 0 - 0
documentation/thread/figures/04thread_sta.png → documentation/3.kernel/thread/figures/04thread_sta.png


+ 0 - 0
documentation/thread/figures/04thread_stack.png → documentation/3.kernel/thread/figures/04thread_stack.png


+ 0 - 0
documentation/thread/figures/04time_slience.png → documentation/3.kernel/thread/figures/04time_slience.png


+ 0 - 0
documentation/thread/thread.md → documentation/3.kernel/thread/thread.md


+ 0 - 0
documentation/timer/figures/05timer_env.png → documentation/3.kernel/timer/figures/05timer_env.png


+ 0 - 0
documentation/timer/figures/05timer_linked_list.png → documentation/3.kernel/timer/figures/05timer_linked_list.png


+ 0 - 0
documentation/timer/figures/05timer_linked_list2.png → documentation/3.kernel/timer/figures/05timer_linked_list2.png


+ 0 - 0
documentation/timer/figures/05timer_ops.png → documentation/3.kernel/timer/figures/05timer_ops.png


+ 0 - 0
documentation/timer/figures/05timer_skip_list.png → documentation/3.kernel/timer/figures/05timer_skip_list.png


+ 0 - 0
documentation/timer/figures/05timer_skip_list2.png → documentation/3.kernel/timer/figures/05timer_skip_list2.png


+ 0 - 0
documentation/timer/figures/05timer_skip_list3.png → documentation/3.kernel/timer/figures/05timer_skip_list3.png


+ 0 - 0
documentation/timer/timer.md → documentation/3.kernel/timer/timer.md


+ 0 - 0
documentation/scons/figures/hello-menu.png → documentation/4.tool/scons/figures/hello-menu.png


+ 0 - 0
documentation/scons/figures/hello-rtconfig.png → documentation/4.tool/scons/figures/hello-rtconfig.png


+ 0 - 0
documentation/scons/figures/hello-value.png → documentation/4.tool/scons/figures/hello-value.png


+ 0 - 0
documentation/scons/figures/hello.png → documentation/4.tool/scons/figures/hello.png


+ 0 - 0
documentation/scons/figures/kconfig.png → documentation/4.tool/scons/figures/kconfig.png


+ 0 - 0
documentation/scons/figures/scons_compile.png → documentation/4.tool/scons/figures/scons_compile.png


+ 0 - 0
documentation/scons/scons.md → documentation/4.tool/scons/scons.md


+ 0 - 0
documentation/device/adc/adc.md → documentation/5.device/adc/adc.md


+ 0 - 0
documentation/device/adc/figures/adc-p.png → documentation/5.device/adc/figures/adc-p.png


+ 0 - 0
documentation/device/device.md → documentation/5.device/framework/device.md


+ 0 - 0
documentation/device/figures/block-dev.png → documentation/5.device/framework/figures/block-dev.png


+ 0 - 0
documentation/device/figures/io-call.png → documentation/5.device/framework/figures/io-call.png


+ 0 - 0
documentation/device/figures/io-dev.png → documentation/5.device/framework/figures/io-dev.png


+ 0 - 0
documentation/device/figures/io-fun-call.png → documentation/5.device/framework/figures/io-fun-call.png


+ 0 - 0
documentation/device/figures/io-parent.png → documentation/5.device/framework/figures/io-parent.png


+ 0 - 0
documentation/device/figures/wtd-uml.png → documentation/5.device/framework/figures/wtd-uml.png


+ 0 - 0
documentation/device/hwtimer/hwtimer.md → documentation/5.device/hwtimer/hwtimer.md


+ 0 - 0
documentation/device/i2c/figures/i2c1.png → documentation/5.device/i2c/figures/i2c1.png


+ 0 - 0
documentation/device/i2c/figures/i2c2.png → documentation/5.device/i2c/figures/i2c2.png


+ 0 - 0
documentation/device/i2c/figures/i2c3.png → documentation/5.device/i2c/figures/i2c3.png


+ 0 - 0
documentation/device/i2c/i2c.md → documentation/5.device/i2c/i2c.md


+ 0 - 0
documentation/device/pin/figures/pin2.png → documentation/5.device/pin/figures/pin2.png


+ 0 - 0
documentation/device/pin/pin.md → documentation/5.device/pin/pin.md


+ 0 - 0
documentation/device/pwm/figures/pwm-f.png → documentation/5.device/pwm/figures/pwm-f.png


Some files were not shown because too many files changed in this diff