diff --git a/config/cca-3world.yaml b/config/cca-3world.yaml index a3e9b5f5f9f69a44c39761c1b131cd0cd38ece41..ddb236ea928d1e9c73ef1a60c99e4ba9e798743c 100644 --- a/config/cca-3world.yaml +++ b/config/cca-3world.yaml @@ -32,8 +32,11 @@ description: >- .. 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 diff --git a/documentation/overview.rst b/documentation/overview.rst index 487f05a9d449f367d05678fee655fa0a0c6cd5c7..2d7a1555b236c366d759276bc5d24325d5bd8f9c 100644 --- a/documentation/overview.rst +++ b/documentation/overview.rst @@ -22,7 +22,7 @@ Shrinkwrap focuses on building FW stacks and configuring the FVP for a desired set of architecture features so that all components are consistent. Engineers bring their own kernel and rootfs to run on top of this foundation. -Shrinkwrap provides an intuative command line interface frontend and (by +Shrinkwrap provides an intuitive command line interface frontend and (by default) a container-based backend so users don't have to think about the tools required to build or run their configs. Everything is also transparent; users can discover every single invoked command with the ``--dry-run`` option. diff --git a/documentation/userguide/configmodel.rst b/documentation/userguide/configmodel.rst index 12c057d038ac8ac4f227c3aa3ccb3d00e43acdb4..debcc6fa2d6cdac3be0fd030af7a1889b7a3cbb9 100644 --- a/documentation/userguide/configmodel.rst +++ b/documentation/userguide/configmodel.rst @@ -226,7 +226,7 @@ key type description friendly string Label to display against the terminal when muxing to stdout. An empty string disables the prefix for the output. port_regex string Regex to use to find the TCP port of the terminal when parsing the FVP stdout. Must have single capture group. type enum-string Terminal type. See below for options. -no_color boolean Optional (defaults to false, only applies to ['stdout', 'stdinout'] types): If true, output from this terminal is not color-coded. If this terminal carries the interactive shell, it is advised to set this to true to prevent interferring with the shell's escape sequences. --no-color command line option causes this to behave as if set to true. +no_color boolean Optional (defaults to false, only applies to ['stdout', 'stdinout'] types): If true, output from this terminal is not color-coded. If this terminal carries the interactive shell, it is advised to set this to true to prevent interfering with the shell's escape sequences. --no-color command line option causes this to behave as if set to true. no_escapes bool/string Optional (defaults to false, only applies to ['stdout', 'stdinout'] types): If true, strips any escape sequences from the output stream before forwarding to the terminal. If a string, behaves as if true until the string is found in the output, which sets it to false. Useful to expunge escape sequences from EDK2 during boot. logfile string Optional (defaults to none, only applies to ['stdout', 'stdinout'] types): Specifies path to a log file where all output to the terminal will be duplicated. =========== =========== =========== diff --git a/documentation/userguide/configstore/cca-3world.rst b/documentation/userguide/configstore/cca-3world.rst index 986a94eac3af8e59714bf2a81602bc5e01a26dd8..c6dd8ac9b99e2d27cd3b11eebb07fb0059bcafd5 100644 --- a/documentation/userguide/configstore/cca-3world.rst +++ b/documentation/userguide/configstore/cca-3world.rst @@ -72,7 +72,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 realmn 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 realm guest can then be launched as previously: .. code-block:: shell diff --git a/documentation/userguide/quickstart.rst b/documentation/userguide/quickstart.rst index ca83ce6c7fbca1b52bdd14054a054687c1b72908..e1d5aac7cfed12f4d34aa30246f4af4d2eee7960 100644 --- a/documentation/userguide/quickstart.rst +++ b/documentation/userguide/quickstart.rst @@ -756,13 +756,13 @@ Alternatively, you could have passed ``--dry-run`` to see the FVP invocation scr Overlays are an important concept for Shrinkwrap. An overlay is a config fragment (either a yaml file or a json-encoded string) that can be passed separately on the command line and forms the top layer of the config. In this -way, it can override or add any required configuration. You could achive the +way, it can override or add any required configuration. You could achieve the same effect by creating a new config and specifying the main config as a layer in that new config, but with an overlay, you can apply a config fragment to many different existing configs without the need to write a new config file each time. You can see overlays being using in the above commands to target a specific Arm architecture revision (v9.3 in the example). You can change the -targetted architecture just by changing the overlay. There are many other places +targeted architecture just by changing the overlay. There are many other places where overlays come in handy. See :ref:`userguide/recipes:Shrinkwrap Recipes` for more examples. diff --git a/documentation/userguide/recipes.rst b/documentation/userguide/recipes.rst index 78fd8573d83e4d4f59d951be73d53bf1bf52cf25..2135f44ccd6bc62fd6ae388a0874749166979fcb 100644 --- a/documentation/userguide/recipes.rst +++ b/documentation/userguide/recipes.rst @@ -226,7 +226,7 @@ Boot Linux with ACPI ``ns-edk2.yaml`` uses EDK2 to boot Linux, and defaults to using the Device Tree. You can change the behaviour to boot with ACPI by passing ``acpi=force`` on the -comand line: +command line: .. code-block:: shell diff --git a/documentation/userguide/runtimes.rst b/documentation/userguide/runtimes.rst index adb30494010374c7071b291b2d7fd27b9215a960..75406777fadc4cda3b5aa6a9f154fb85bf307a21 100644 --- a/documentation/userguide/runtimes.rst +++ b/documentation/userguide/runtimes.rst @@ -51,7 +51,7 @@ freely downloaded without the need for an account. image name description =============================================== ==== docker.io/shrinkwraptool/base-slim-nofvp:latest Contains all toolchains and other dependencies required to build all standard configs. Can be used as a base to create an image with a custom FVP. -docker.io/shrinkwraptool/base-slim:latest (default). As per ``shrinkwraptool/base-slim-nofvp:latest`` but also contains the Base_RevC-2xAEMvA FVP. This is suffcient for most use cases and is much smaller than the ``full`` variant. +docker.io/shrinkwraptool/base-slim:latest (default). As per ``shrinkwraptool/base-slim-nofvp:latest`` but also contains the Base_RevC-2xAEMvA FVP. This is sufficient for most use cases and is much smaller than the ``full`` variant. docker.io/shrinkwraptool/base-full-nofvp:latest Builds upon ``shrinkwraptool/base-slim:latest``, adding aarch32 toolchains (both arm-none-eabi and arm-linux-gnueabihf). These are not needed for standard configs, but will be required if creating a custom config that includes (e.g.) SCP FW. Separated out due to big size increase. docker.io/shrinkwraptool/base-full:latest As per ``shrinkwraptool/base-full-nofvp:latest`` but also contains the Base_RevC-2xAEMvA FVP. =============================================== ====