Skip to contentSkip to conversation

doc: usage: Group all shell command docs into cmd/ sub-direcotry

PATCH In review Bin Meng 2 participants 2 messages Mar 28, 2022 – Mar 29, 2022

lore
Share & tools
lore

Bin Meng

author
#0 lore raw

PATCH 1/1 doc: usage: Group all shell command docs into cmd/ sub-direcotry

Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-direcotry.

---

 doc/usage/{ => cmd}/acpi.rst         |  0
 doc/usage/{ => cmd}/addrmap.rst      |  0
 doc/usage/{ => cmd}/askenv.rst       |  0
 doc/usage/{ => cmd}/base.rst         |  0
 doc/usage/{ => cmd}/bootefi.rst      |  0
 doc/usage/{ => cmd}/booti.rst        |  0
 doc/usage/{ => cmd}/bootmenu.rst     |  0
 doc/usage/{ => cmd}/button.rst       |  0
 doc/usage/{x86 => cmd}/cbsysinfo.rst |  0
 doc/usage/{ => cmd}/conitrace.rst    |  0
 doc/usage/{ => cmd}/echo.rst         |  0
 doc/usage/{ => cmd}/exception.rst    |  0
 doc/usage/{ => cmd}/exit.rst         |  0
 doc/usage/{ => cmd}/extension.rst    |  0
 doc/usage/{ => cmd}/false.rst        |  0
 doc/usage/{ => cmd}/fatinfo.rst      |  0
 doc/usage/{ => cmd}/fatload.rst      |  0
 doc/usage/{ => cmd}/for.rst          |  0
 doc/usage/{ => cmd}/load.rst         |  0
 doc/usage/{ => cmd}/loady.rst        |  0
 doc/usage/{ => cmd}/mbr.rst          |  0
 doc/usage/{ => cmd}/md.rst           |  0
 doc/usage/{ => cmd}/mmc.rst          |  0
 doc/usage/{ => cmd}/pinmux.rst       |  0
 doc/usage/{ => cmd}/pstore.rst       |  0
 doc/usage/{ => cmd}/qfw.rst          |  0
 doc/usage/{ => cmd}/reset.rst        |  0
 doc/usage/{ => cmd}/sbi.rst          |  0
 doc/usage/{ => cmd}/scp03.rst        |  0
 doc/usage/{ => cmd}/setexpr.rst      |  0
 doc/usage/{ => cmd}/sf.rst           |  0
 doc/usage/{ => cmd}/size.rst         |  0
 doc/usage/{ => cmd}/true.rst         |  0
 doc/usage/{ => cmd}/ums.rst          |  0
 doc/usage/index.rst                  | 68 ++++++++++++++--------------
 35 files changed, 34 insertions(+), 34 deletions(-)
 rename doc/usage/{ => cmd}/acpi.rst (100%)
 rename doc/usage/{ => cmd}/addrmap.rst (100%)
 rename doc/usage/{ => cmd}/askenv.rst (100%)
 rename doc/usage/{ => cmd}/base.rst (100%)
 rename doc/usage/{ => cmd}/bootefi.rst (100%)
 rename doc/usage/{ => cmd}/booti.rst (100%)
 rename doc/usage/{ => cmd}/bootmenu.rst (100%)
 rename doc/usage/{ => cmd}/button.rst (100%)
 rename doc/usage/{x86 => cmd}/cbsysinfo.rst (100%)
 rename doc/usage/{ => cmd}/conitrace.rst (100%)
 rename doc/usage/{ => cmd}/echo.rst (100%)
 rename doc/usage/{ => cmd}/exception.rst (100%)
 rename doc/usage/{ => cmd}/exit.rst (100%)
 rename doc/usage/{ => cmd}/extension.rst (100%)
 rename doc/usage/{ => cmd}/false.rst (100%)
 rename doc/usage/{ => cmd}/fatinfo.rst (100%)
 rename doc/usage/{ => cmd}/fatload.rst (100%)
 rename doc/usage/{ => cmd}/for.rst (100%)
 rename doc/usage/{ => cmd}/load.rst (100%)
 rename doc/usage/{ => cmd}/loady.rst (100%)
 rename doc/usage/{ => cmd}/mbr.rst (100%)
 rename doc/usage/{ => cmd}/md.rst (100%)
 rename doc/usage/{ => cmd}/mmc.rst (100%)
 rename doc/usage/{ => cmd}/pinmux.rst (100%)
 rename doc/usage/{ => cmd}/pstore.rst (100%)
 rename doc/usage/{ => cmd}/qfw.rst (100%)
 rename doc/usage/{ => cmd}/reset.rst (100%)
 rename doc/usage/{ => cmd}/sbi.rst (100%)
 rename doc/usage/{ => cmd}/scp03.rst (100%)
 rename doc/usage/{ => cmd}/setexpr.rst (100%)
 rename doc/usage/{ => cmd}/sf.rst (100%)
 rename doc/usage/{ => cmd}/size.rst (100%)
 rename doc/usage/{ => cmd}/true.rst (100%)
 rename doc/usage/{ => cmd}/ums.rst (100%)
doc/usage/cmd/acpi.rst renamed from doc/usage/acpi.rst +0 -0
similarity index 100%
rename from doc/usage/acpi.rst
rename to doc/usage/cmd/acpi.rst
doc/usage/cmd/addrmap.rst renamed from doc/usage/addrmap.rst +0 -0
similarity index 100%
rename from doc/usage/addrmap.rst
rename to doc/usage/cmd/addrmap.rst
doc/usage/cmd/askenv.rst renamed from doc/usage/askenv.rst +0 -0
similarity index 100%
rename from doc/usage/askenv.rst
rename to doc/usage/cmd/askenv.rst
doc/usage/cmd/base.rst renamed from doc/usage/base.rst +0 -0
similarity index 100%
rename from doc/usage/base.rst
rename to doc/usage/cmd/base.rst
doc/usage/cmd/bootefi.rst renamed from doc/usage/bootefi.rst +0 -0
similarity index 100%
rename from doc/usage/bootefi.rst
rename to doc/usage/cmd/bootefi.rst
doc/usage/cmd/booti.rst renamed from doc/usage/booti.rst +0 -0
similarity index 100%
rename from doc/usage/booti.rst
rename to doc/usage/cmd/booti.rst
doc/usage/cmd/bootmenu.rst renamed from doc/usage/bootmenu.rst +0 -0
similarity index 100%
rename from doc/usage/bootmenu.rst
rename to doc/usage/cmd/bootmenu.rst
doc/usage/cmd/button.rst renamed from doc/usage/button.rst +0 -0
similarity index 100%
rename from doc/usage/button.rst
rename to doc/usage/cmd/button.rst
doc/usage/cmd/cbsysinfo.rst renamed from doc/usage/x86/cbsysinfo.rst +0 -0
similarity index 100%
rename from doc/usage/x86/cbsysinfo.rst
rename to doc/usage/cmd/cbsysinfo.rst
doc/usage/cmd/conitrace.rst renamed from doc/usage/conitrace.rst +0 -0
similarity index 100%
rename from doc/usage/conitrace.rst
rename to doc/usage/cmd/conitrace.rst
doc/usage/cmd/echo.rst renamed from doc/usage/echo.rst +0 -0
similarity index 100%
rename from doc/usage/echo.rst
rename to doc/usage/cmd/echo.rst
doc/usage/cmd/exception.rst renamed from doc/usage/exception.rst +0 -0
similarity index 100%
rename from doc/usage/exception.rst
rename to doc/usage/cmd/exception.rst
doc/usage/cmd/exit.rst renamed from doc/usage/exit.rst +0 -0
similarity index 100%
rename from doc/usage/exit.rst
rename to doc/usage/cmd/exit.rst
doc/usage/cmd/extension.rst renamed from doc/usage/extension.rst +0 -0
similarity index 100%
rename from doc/usage/extension.rst
rename to doc/usage/cmd/extension.rst
doc/usage/cmd/false.rst renamed from doc/usage/false.rst +0 -0
similarity index 100%
rename from doc/usage/false.rst
rename to doc/usage/cmd/false.rst
doc/usage/cmd/fatinfo.rst renamed from doc/usage/fatinfo.rst +0 -0
similarity index 100%
rename from doc/usage/fatinfo.rst
rename to doc/usage/cmd/fatinfo.rst
doc/usage/cmd/fatload.rst renamed from doc/usage/fatload.rst +0 -0
similarity index 100%
rename from doc/usage/fatload.rst
rename to doc/usage/cmd/fatload.rst
doc/usage/cmd/for.rst renamed from doc/usage/for.rst +0 -0
similarity index 100%
rename from doc/usage/for.rst
rename to doc/usage/cmd/for.rst
doc/usage/cmd/load.rst renamed from doc/usage/load.rst +0 -0
similarity index 100%
rename from doc/usage/load.rst
rename to doc/usage/cmd/load.rst
doc/usage/cmd/loady.rst renamed from doc/usage/loady.rst +0 -0
similarity index 100%
rename from doc/usage/loady.rst
rename to doc/usage/cmd/loady.rst
doc/usage/cmd/mbr.rst renamed from doc/usage/mbr.rst +0 -0
similarity index 100%
rename from doc/usage/mbr.rst
rename to doc/usage/cmd/mbr.rst
doc/usage/cmd/md.rst renamed from doc/usage/md.rst +0 -0
similarity index 100%
rename from doc/usage/md.rst
rename to doc/usage/cmd/md.rst
doc/usage/cmd/mmc.rst renamed from doc/usage/mmc.rst +0 -0
similarity index 100%
rename from doc/usage/mmc.rst
rename to doc/usage/cmd/mmc.rst
doc/usage/cmd/pinmux.rst renamed from doc/usage/pinmux.rst +0 -0
similarity index 100%
rename from doc/usage/pinmux.rst
rename to doc/usage/cmd/pinmux.rst
doc/usage/cmd/pstore.rst renamed from doc/usage/pstore.rst +0 -0
similarity index 100%
rename from doc/usage/pstore.rst
rename to doc/usage/cmd/pstore.rst
doc/usage/cmd/qfw.rst renamed from doc/usage/qfw.rst +0 -0
similarity index 100%
rename from doc/usage/qfw.rst
rename to doc/usage/cmd/qfw.rst
doc/usage/cmd/reset.rst renamed from doc/usage/reset.rst +0 -0
similarity index 100%
rename from doc/usage/reset.rst
rename to doc/usage/cmd/reset.rst
doc/usage/cmd/sbi.rst renamed from doc/usage/sbi.rst +0 -0
similarity index 100%
rename from doc/usage/sbi.rst
rename to doc/usage/cmd/sbi.rst
doc/usage/cmd/scp03.rst renamed from doc/usage/scp03.rst +0 -0
similarity index 100%
rename from doc/usage/scp03.rst
rename to doc/usage/cmd/scp03.rst
doc/usage/cmd/setexpr.rst renamed from doc/usage/setexpr.rst +0 -0
similarity index 100%
rename from doc/usage/setexpr.rst
rename to doc/usage/cmd/setexpr.rst
doc/usage/cmd/sf.rst renamed from doc/usage/sf.rst +0 -0
similarity index 100%
rename from doc/usage/sf.rst
rename to doc/usage/cmd/sf.rst
doc/usage/cmd/size.rst renamed from doc/usage/size.rst +0 -0
similarity index 100%
rename from doc/usage/size.rst
rename to doc/usage/cmd/size.rst
doc/usage/cmd/true.rst renamed from doc/usage/true.rst +0 -0
similarity index 100%
rename from doc/usage/true.rst
rename to doc/usage/cmd/true.rst
doc/usage/cmd/ums.rst renamed from doc/usage/ums.rst +0 -0
similarity index 100%
rename from doc/usage/ums.rst
rename to doc/usage/cmd/ums.rst
doc/usage/index.rst +34 -34

74 lines not on this page · raw message

Signature · 1 line
2.25.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 2 lines · Bin Meng

Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-direcotry.

%s/direcotry/directory/

I will fix that.

Quoted 30 lines

---

  doc/usage/{ => cmd}/acpi.rst         |  0
  doc/usage/{ => cmd}/addrmap.rst      |  0
  doc/usage/{ => cmd}/askenv.rst       |  0
  doc/usage/{ => cmd}/base.rst         |  0
  doc/usage/{ => cmd}/bootefi.rst      |  0
  doc/usage/{ => cmd}/booti.rst        |  0
  doc/usage/{ => cmd}/bootmenu.rst     |  0
  doc/usage/{ => cmd}/button.rst       |  0
  doc/usage/{x86 => cmd}/cbsysinfo.rst |  0
  doc/usage/{ => cmd}/conitrace.rst    |  0
  doc/usage/{ => cmd}/echo.rst         |  0
  doc/usage/{ => cmd}/exception.rst    |  0
  doc/usage/{ => cmd}/exit.rst         |  0
  doc/usage/{ => cmd}/extension.rst    |  0
  doc/usage/{ => cmd}/false.rst        |  0
  doc/usage/{ => cmd}/fatinfo.rst      |  0
  doc/usage/{ => cmd}/fatload.rst      |  0
  doc/usage/{ => cmd}/for.rst          |  0
  doc/usage/{ => cmd}/load.rst         |  0
  doc/usage/{ => cmd}/loady.rst        |  0
  doc/usage/{ => cmd}/mbr.rst          |  0
  doc/usage/{ => cmd}/md.rst           |  0
  doc/usage/{ => cmd}/mmc.rst          |  0
  doc/usage/{ => cmd}/pinmux.rst       |  0
  doc/usage/{ => cmd}/pstore.rst       |  0
  doc/usage/{ => cmd}/qfw.rst          |  0
Quoted 8 lines
  doc/usage/{ => cmd}/reset.rst        |  0
  doc/usage/{ => cmd}/sbi.rst          |  0
  doc/usage/{ => cmd}/scp03.rst        |  0
  doc/usage/{ => cmd}/setexpr.rst      |  0
  doc/usage/{ => cmd}/sf.rst           |  0
  doc/usage/{ => cmd}/size.rst         |  0
  doc/usage/{ => cmd}/true.rst         |  0
  doc/usage/{ => cmd}/ums.rst          |  0

wdt.rst was added recently.

I will fix that when merging.

Quoted 252 lines
  doc/usage/index.rst                  | 68 ++++++++++++++--------------
  35 files changed, 34 insertions(+), 34 deletions(-)

rename doc/usage/{ => cmd}/acpi.rst (100%) rename doc/usage/{ => cmd}/addrmap.rst (100%) rename doc/usage/{ => cmd}/askenv.rst (100%) rename doc/usage/{ => cmd}/base.rst (100%) rename doc/usage/{ => cmd}/bootefi.rst (100%) rename doc/usage/{ => cmd}/booti.rst (100%) rename doc/usage/{ => cmd}/bootmenu.rst (100%) rename doc/usage/{ => cmd}/button.rst (100%) rename doc/usage/{x86 => cmd}/cbsysinfo.rst (100%) rename doc/usage/{ => cmd}/conitrace.rst (100%) rename doc/usage/{ => cmd}/echo.rst (100%) rename doc/usage/{ => cmd}/exception.rst (100%) rename doc/usage/{ => cmd}/exit.rst (100%) rename doc/usage/{ => cmd}/extension.rst (100%) rename doc/usage/{ => cmd}/false.rst (100%) rename doc/usage/{ => cmd}/fatinfo.rst (100%) rename doc/usage/{ => cmd}/fatload.rst (100%) rename doc/usage/{ => cmd}/for.rst (100%) rename doc/usage/{ => cmd}/load.rst (100%) rename doc/usage/{ => cmd}/loady.rst (100%) rename doc/usage/{ => cmd}/mbr.rst (100%) rename doc/usage/{ => cmd}/md.rst (100%) rename doc/usage/{ => cmd}/mmc.rst (100%) rename doc/usage/{ => cmd}/pinmux.rst (100%) rename doc/usage/{ => cmd}/pstore.rst (100%) rename doc/usage/{ => cmd}/qfw.rst (100%) rename doc/usage/{ => cmd}/reset.rst (100%) rename doc/usage/{ => cmd}/sbi.rst (100%) rename doc/usage/{ => cmd}/scp03.rst (100%) rename doc/usage/{ => cmd}/setexpr.rst (100%) rename doc/usage/{ => cmd}/sf.rst (100%) rename doc/usage/{ => cmd}/size.rst (100%) rename doc/usage/{ => cmd}/true.rst (100%) rename doc/usage/{ => cmd}/ums.rst (100%)

doc/usage/cmd/acpi.rst renamed from doc/usage/acpi.rst +0 -0
similarity index 100%
rename from doc/usage/acpi.rst
rename to doc/usage/cmd/acpi.rst
doc/usage/cmd/addrmap.rst renamed from doc/usage/addrmap.rst +0 -0
similarity index 100%
rename from doc/usage/addrmap.rst
rename to doc/usage/cmd/addrmap.rst
doc/usage/cmd/askenv.rst renamed from doc/usage/askenv.rst +0 -0
similarity index 100%
rename from doc/usage/askenv.rst
rename to doc/usage/cmd/askenv.rst
doc/usage/cmd/base.rst renamed from doc/usage/base.rst +0 -0
similarity index 100%
rename from doc/usage/base.rst
rename to doc/usage/cmd/base.rst
doc/usage/cmd/bootefi.rst renamed from doc/usage/bootefi.rst +0 -0
similarity index 100%
rename from doc/usage/bootefi.rst
rename to doc/usage/cmd/bootefi.rst
doc/usage/cmd/booti.rst renamed from doc/usage/booti.rst +0 -0
similarity index 100%
rename from doc/usage/booti.rst
rename to doc/usage/cmd/booti.rst
doc/usage/cmd/bootmenu.rst renamed from doc/usage/bootmenu.rst +0 -0
similarity index 100%
rename from doc/usage/bootmenu.rst
rename to doc/usage/cmd/bootmenu.rst
doc/usage/cmd/button.rst renamed from doc/usage/button.rst +0 -0
similarity index 100%
rename from doc/usage/button.rst
rename to doc/usage/cmd/button.rst
doc/usage/cmd/cbsysinfo.rst renamed from doc/usage/x86/cbsysinfo.rst +0 -0
similarity index 100%
rename from doc/usage/x86/cbsysinfo.rst
rename to doc/usage/cmd/cbsysinfo.rst
doc/usage/cmd/conitrace.rst renamed from doc/usage/conitrace.rst +0 -0
similarity index 100%
rename from doc/usage/conitrace.rst
rename to doc/usage/cmd/conitrace.rst
doc/usage/cmd/echo.rst renamed from doc/usage/echo.rst +0 -0
similarity index 100%
rename from doc/usage/echo.rst
rename to doc/usage/cmd/echo.rst
doc/usage/cmd/exception.rst renamed from doc/usage/exception.rst +0 -0
similarity index 100%
rename from doc/usage/exception.rst
rename to doc/usage/cmd/exception.rst
doc/usage/cmd/exit.rst renamed from doc/usage/exit.rst +0 -0
similarity index 100%
rename from doc/usage/exit.rst
rename to doc/usage/cmd/exit.rst
doc/usage/cmd/extension.rst renamed from doc/usage/extension.rst +0 -0
similarity index 100%
rename from doc/usage/extension.rst
rename to doc/usage/cmd/extension.rst
doc/usage/cmd/false.rst renamed from doc/usage/false.rst +0 -0
similarity index 100%
rename from doc/usage/false.rst
rename to doc/usage/cmd/false.rst
doc/usage/cmd/fatinfo.rst renamed from doc/usage/fatinfo.rst +0 -0
similarity index 100%
rename from doc/usage/fatinfo.rst
rename to doc/usage/cmd/fatinfo.rst
doc/usage/cmd/fatload.rst renamed from doc/usage/fatload.rst +0 -0
similarity index 100%
rename from doc/usage/fatload.rst
rename to doc/usage/cmd/fatload.rst
doc/usage/cmd/for.rst renamed from doc/usage/for.rst +0 -0
similarity index 100%
rename from doc/usage/for.rst
rename to doc/usage/cmd/for.rst
doc/usage/cmd/load.rst renamed from doc/usage/load.rst +0 -0
similarity index 100%
rename from doc/usage/load.rst
rename to doc/usage/cmd/load.rst
doc/usage/cmd/loady.rst renamed from doc/usage/loady.rst +0 -0
similarity index 100%
rename from doc/usage/loady.rst
rename to doc/usage/cmd/loady.rst
doc/usage/cmd/mbr.rst renamed from doc/usage/mbr.rst +0 -0
similarity index 100%
rename from doc/usage/mbr.rst
rename to doc/usage/cmd/mbr.rst
doc/usage/cmd/md.rst renamed from doc/usage/md.rst +0 -0
similarity index 100%
rename from doc/usage/md.rst
rename to doc/usage/cmd/md.rst
doc/usage/cmd/mmc.rst renamed from doc/usage/mmc.rst +0 -0
similarity index 100%
rename from doc/usage/mmc.rst
rename to doc/usage/cmd/mmc.rst
doc/usage/cmd/pinmux.rst renamed from doc/usage/pinmux.rst +0 -0
similarity index 100%
rename from doc/usage/pinmux.rst
rename to doc/usage/cmd/pinmux.rst
doc/usage/cmd/pstore.rst renamed from doc/usage/pstore.rst +0 -0
similarity index 100%
rename from doc/usage/pstore.rst
rename to doc/usage/cmd/pstore.rst
doc/usage/cmd/qfw.rst renamed from doc/usage/qfw.rst +0 -0
similarity index 100%
rename from doc/usage/qfw.rst
rename to doc/usage/cmd/qfw.rst
doc/usage/cmd/reset.rst renamed from doc/usage/reset.rst +0 -0
similarity index 100%
rename from doc/usage/reset.rst
rename to doc/usage/cmd/reset.rst
doc/usage/cmd/sbi.rst renamed from doc/usage/sbi.rst +0 -0
similarity index 100%
rename from doc/usage/sbi.rst
rename to doc/usage/cmd/sbi.rst
doc/usage/cmd/scp03.rst renamed from doc/usage/scp03.rst +0 -0
similarity index 100%
rename from doc/usage/scp03.rst
rename to doc/usage/cmd/scp03.rst
doc/usage/cmd/setexpr.rst renamed from doc/usage/setexpr.rst +0 -0
similarity index 100%
rename from doc/usage/setexpr.rst
rename to doc/usage/cmd/setexpr.rst
doc/usage/cmd/sf.rst renamed from doc/usage/sf.rst +0 -0
similarity index 100%
rename from doc/usage/sf.rst
rename to doc/usage/cmd/sf.rst
doc/usage/cmd/size.rst renamed from doc/usage/size.rst +0 -0
similarity index 100%
rename from doc/usage/size.rst
rename to doc/usage/cmd/size.rst
doc/usage/cmd/true.rst renamed from doc/usage/true.rst +0 -0
similarity index 100%
rename from doc/usage/true.rst
rename to doc/usage/cmd/true.rst
doc/usage/cmd/ums.rst renamed from doc/usage/ums.rst +0 -0
similarity index 100%
rename from doc/usage/ums.rst
rename to doc/usage/cmd/ums.rst
doc/usage/index.rst +34 -34
index ecb4908fd1..5c5fbf51b8 100644
@@ -18,40 +18,40 @@ Shell commands
  .. toctree::
     :maxdepth: 1
 
-   acpi
-   addrmap
-   askenv
-   base
-   bootefi
-   booti
-   bootmenu
-   button
-   x86/cbsysinfo
-   conitrace
-   echo
-   exception
-   extension
-   exit
-   false
-   fatinfo
-   fatload
-   for
-   load
-   loady
-   mbr
-   md
-   mmc
-   pinmux
-   pstore
-   qfw
-   reset
-   sbi
-   sf
-   scp03
-   setexpr
-   size
-   true
-   ums
+   cmd/acpi
+   cmd/addrmap
+   cmd/askenv
+   cmd/base
+   cmd/bootefi
+   cmd/booti
+   cmd/bootmenu
+   cmd/button
+   cmd/cbsysinfo
+   cmd/conitrace
+   cmd/echo
+   cmd/exception
+   cmd/extension
+   cmd/exit
+   cmd/false
+   cmd/fatinfo
+   cmd/fatload
+   cmd/for
+   cmd/load
+   cmd/loady
+   cmd/mbr
+   cmd/md
+   cmd/mmc
+   cmd/pinmux
+   cmd/pstore
+   cmd/qfw
+   cmd/reset
+   cmd/sbi
+   cmd/sf
+   cmd/scp03
+   cmd/setexpr
+   cmd/size
+   cmd/true
+   cmd/ums
 
  Booting OS
  ----------