From 00175af3fe7b1a44128f5224473474cfb5798829 Mon Sep 17 00:00:00 2001 From: Arnaud de Grandmaison Date: Tue, 24 Sep 2024 10:59:07 +0200 Subject: [PATCH] doc: keep build- and run-time variables sorted. As a developer, this will ease reviewing documentation changes, and as a user, this helps finding the variable one is looking for when there is a large number fo variables. Signed-off-by: Arnaud de Grandmaison --- documentation/_scripts/genconfigstore.py | 2 +- documentation/userguide/configstore/bootwrapper.rst | 2 +- documentation/userguide/configstore/cca-3world.rst | 13 ++++++++----- documentation/userguide/configstore/cca-4world.rst | 8 ++++---- .../userguide/configstore/ffa-hafnium-optee.rst | 8 ++++---- documentation/userguide/configstore/ffa-optee.rst | 8 ++++---- documentation/userguide/configstore/ffa-tftf.rst | 8 ++++---- .../userguide/configstore/ns-edk2-optee.rst | 8 ++++---- documentation/userguide/configstore/ns-edk2.rst | 8 ++++---- documentation/userguide/configstore/ns-preload.rst | 2 +- 10 files changed, 35 insertions(+), 32 deletions(-) diff --git a/documentation/_scripts/genconfigstore.py b/documentation/_scripts/genconfigstore.py index 8940a9b..571af0e 100755 --- a/documentation/_scripts/genconfigstore.py +++ b/documentation/_scripts/genconfigstore.py @@ -40,7 +40,7 @@ def make_rst_table(headers, data): def make_rst_table_from_dict(headers, data): - return make_rst_table(headers, [(k, v) for k, v in data.items()]) + return make_rst_table(headers, sorted(data.items())) def fix_whitespace(text): diff --git a/documentation/userguide/configstore/bootwrapper.rst b/documentation/userguide/configstore/bootwrapper.rst index a401f2f..9c522b2 100644 --- a/documentation/userguide/configstore/bootwrapper.rst +++ b/documentation/userguide/configstore/bootwrapper.rst @@ -33,8 +33,8 @@ Run-Time Variables ============== ======= rtvar default ============== ======= -LOCAL_NET_PORT 8022 BOOTWRAPPER +LOCAL_NET_PORT 8022 ROOTFS ============== ======= diff --git a/documentation/userguide/configstore/cca-3world.rst b/documentation/userguide/configstore/cca-3world.rst index c6dd8ac..b5ab2cb 100644 --- a/documentation/userguide/configstore/cca-3world.rst +++ b/documentation/userguide/configstore/cca-3world.rst @@ -26,8 +26,11 @@ For the time being, there is an issue in the linux kernel's handling of 9p which .. code-block:: shell $ cd ~/.shrinkwrap/package/cca-3world + $ ORIGINAL_PATH=$PATH + $ export PATH=$PATH:~/.shrinkwrap/build/build/cca-3world/buildroot/host/bin/ $ e2fsck -fp rootfs.ext2 $ resize2fs rootfs.ext2 256M + $ export PATH=$ORIGINAL_PATH $ sudo su # mkdir mnt # mount rootfs.ext2 mnt @@ -72,7 +75,7 @@ When the linux kernel 9p issue will be fixed, the shared directory approach can $ shrinkwrap run cca-3world.yaml --rtvar ROOTFS=rootfs.ext2 --rtvar SHARE=. -Then, once the host has booted, log in as "root" (no password) and mount the shared folder to "/cca" and change dir to it. The realm guest can then be launched as previously: +Then, once the host has booted, log in as "root" (no password) and mount the shared folder to "/cca" and change dir to it. The realmn guest can then be launched as previously: .. code-block:: shell @@ -101,14 +104,14 @@ Run-Time Variables ============== =============================================================== rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +DTB ${artifact:DTB} +EDK2FLASH +FIP ${artifact:FIP} KERNEL ${artifact:KERNEL} +LOCAL_NET_PORT 8022 ROOTFS SHARE -EDK2FLASH ============== =============================================================== diff --git a/documentation/userguide/configstore/cca-4world.rst b/documentation/userguide/configstore/cca-4world.rst index 0fc46c8..c28e06a 100644 --- a/documentation/userguide/configstore/cca-4world.rst +++ b/documentation/userguide/configstore/cca-4world.rst @@ -60,14 +60,14 @@ Run-Time Variables ============== =============================================================== rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +DTB ${artifact:DTB} +EDK2FLASH +FIP ${artifact:FIP} KERNEL ${artifact:KERNEL} +LOCAL_NET_PORT 8022 ROOTFS SHARE -EDK2FLASH ============== =============================================================== diff --git a/documentation/userguide/configstore/ffa-hafnium-optee.rst b/documentation/userguide/configstore/ffa-hafnium-optee.rst index 5128aa7..e6370df 100644 --- a/documentation/userguide/configstore/ffa-hafnium-optee.rst +++ b/documentation/userguide/configstore/ffa-hafnium-optee.rst @@ -31,14 +31,14 @@ Run-Time Variables ============== =============================================================== rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +DTB ${artifact:DTB} +EDK2FLASH +FIP ${artifact:FIP} KERNEL +LOCAL_NET_PORT 8022 ROOTFS SHARE -EDK2FLASH ============== =============================================================== diff --git a/documentation/userguide/configstore/ffa-optee.rst b/documentation/userguide/configstore/ffa-optee.rst index 388ecd3..8840f70 100644 --- a/documentation/userguide/configstore/ffa-optee.rst +++ b/documentation/userguide/configstore/ffa-optee.rst @@ -31,14 +31,14 @@ Run-Time Variables ============== =============================================================== rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +DTB ${artifact:DTB} +EDK2FLASH +FIP ${artifact:FIP} KERNEL +LOCAL_NET_PORT 8022 ROOTFS SHARE -EDK2FLASH ============== =============================================================== diff --git a/documentation/userguide/configstore/ffa-tftf.rst b/documentation/userguide/configstore/ffa-tftf.rst index ee62b95..aa8f1a2 100644 --- a/documentation/userguide/configstore/ffa-tftf.rst +++ b/documentation/userguide/configstore/ffa-tftf.rst @@ -31,14 +31,14 @@ Run-Time Variables ============== =============================================================== rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +DTB ${artifact:DTB} +EDK2FLASH +FIP ${artifact:FIP} KERNEL +LOCAL_NET_PORT 8022 ROOTFS SHARE -EDK2FLASH ============== =============================================================== diff --git a/documentation/userguide/configstore/ns-edk2-optee.rst b/documentation/userguide/configstore/ns-edk2-optee.rst index aa1f085..936b6c1 100644 --- a/documentation/userguide/configstore/ns-edk2-optee.rst +++ b/documentation/userguide/configstore/ns-edk2-optee.rst @@ -31,14 +31,14 @@ Run-Time Variables ============== =============================================================== rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +DTB ${artifact:DTB} +EDK2FLASH +FIP ${artifact:FIP} KERNEL +LOCAL_NET_PORT 8022 ROOTFS SHARE -EDK2FLASH ============== =============================================================== diff --git a/documentation/userguide/configstore/ns-edk2.rst b/documentation/userguide/configstore/ns-edk2.rst index 04d321b..2fde25a 100644 --- a/documentation/userguide/configstore/ns-edk2.rst +++ b/documentation/userguide/configstore/ns-edk2.rst @@ -46,14 +46,14 @@ Run-Time Variables ============== =============================================================== rtvar default ============== =============================================================== -LOCAL_NET_PORT 8022 BL1 ${artifact:BL1} -FIP ${artifact:FIP} -DTB ${artifact:DTB} CMDLINE console=ttyAMA0 earlycon=pl011,0x1c090000 root=/dev/vda ip=dhcp +DTB ${artifact:DTB} +EDK2FLASH +FIP ${artifact:FIP} KERNEL +LOCAL_NET_PORT 8022 ROOTFS SHARE -EDK2FLASH ============== =============================================================== diff --git a/documentation/userguide/configstore/ns-preload.rst b/documentation/userguide/configstore/ns-preload.rst index 4531fd0..28ae1d9 100644 --- a/documentation/userguide/configstore/ns-preload.rst +++ b/documentation/userguide/configstore/ns-preload.rst @@ -42,10 +42,10 @@ Run-Time Variables ============== ================ rtvar default ============== ================ -LOCAL_NET_PORT 8022 BL31 ${artifact:BL31} DTB ${artifact:DTB} KERNEL +LOCAL_NET_PORT 8022 ROOTFS SHARE ============== ================ -- GitLab