diff mbox series

[honister] arm-bsp/docs: Minor fvp-baser-aemv8r64 fixes

Message ID 20220308112953.3800922-1-peter.hoyes@arm.com
State New
Headers show
Series [honister] arm-bsp/docs: Minor fvp-baser-aemv8r64 fixes | expand

Commit Message

Peter Hoyes March 8, 2022, 11:29 a.m. UTC 
From: Peter Hoyes <Peter.Hoyes@arm.com>

 * Include `--upgrade` in pip3 command to ensure latest kas version is
   installed
 * Ensure all underscores are either quoted or escaped
 * Fix P9 example command

Issue-Id: SCM-3881
Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
Change-Id: Ie460dbd6b1f87f5f9ca2966329341d22da3606d3
---
 .../documentation/fvp-baser-aemv8r64.md        | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

Comments

Jon Mason March 8, 2022, 3:17 p.m. UTC | #1 
On Tue, 8 Mar 2022 11:29:53 +0000, Peter Hoyes wrote:
>  * Include `--upgrade` in pip3 command to ensure latest kas version is
>    installed
>  * Ensure all underscores are either quoted or escaped
>  * Fix P9 example command

Applied, thanks!

[1/1] arm-bsp/docs: Minor fvp-baser-aemv8r64 fixes
      commit: fbfd015578f1c206c9d44b5bfda485c81c411e0c

Best regards,
diff mbox series

Patch

diff --git a/meta-arm-bsp/documentation/fvp-baser-aemv8r64.md b/meta-arm-bsp/documentation/fvp-baser-aemv8r64.md
index b137776..3cc3a12 100644
--- a/meta-arm-bsp/documentation/fvp-baser-aemv8r64.md
+++ b/meta-arm-bsp/documentation/fvp-baser-aemv8r64.md
@@ -100,7 +100,7 @@  https://docs.yoctoproject.org/singleindex.html#required-packages-for-the-build-h
 Kas is a setup tool for bitbake based projects. The minimal supported version
 is 2.6, install it like so:
 
-    pip3 install --user kas
+    pip3 install --user --upgrade kas
 
 For more details on kas, see https://kas.readthedocs.io/.
 
@@ -193,7 +193,7 @@  e.g. for the standard Linux kernel:
     kas shell --keep-config-unchanged \
        meta-arm/kas/fvp-baser-aemv8r64-bsp.yml \
            --command "../layers/meta-arm/scripts/runfvp \
-           --console --parameter
+           --console -- --parameter \
            'bp.virtiop9device.root_path=/path/to/host-mount-dir'"
 
 Once you are logged into the fvp, the host directory can be mounted in a
@@ -217,10 +217,10 @@  Known Issues and Limitations
 - Only PSCI CPU\_ON and CPU\_OFF functions are supported
 - Linux kernel does not support booting from secure EL2 on Armv8-R AArch64
 - Linux KVM does not support Armv8-R AArch64
-- Device DMA memory cache-coherence issue: the FVP cache_state_modelled
+- Device DMA memory cache-coherence issue: the FVP `cache_state_modelled`
   parameter will affect the cache coherence behavior of peripherals’ DMA. When
-  users set cache_state_modelled=1, they also have to set
-  cci400.force_on_from_start=1 to force the FVP to enable snooping on upstream
+  users set `cache_state_modelled=1`, they also have to set
+  `cci400.force_on_from_start=1` to force the FVP to enable snooping on upstream
   ports.
 
 Change Log
@@ -228,16 +228,16 @@  Change Log
 
 - Added U-Boot v2021.07 for UEFI support.
 - Updated boot-wrapper-aarch64 revision and added support for booting U-Boot.
-- Included boot-wrapper-aarch64 PSCI services in /memreserve/ region.
+- Included boot-wrapper-aarch64 PSCI services in `/memreserve/` region.
 - Fixed the counter frequency initialization in boot-wrapper-aarch64.
 - Configured the FVP to use the default RAM size of 4 Gb
 - Fixed PL011 and SP805 register sizes in the device tree.
-- Added virtio_net User Networking mode by default and removed instructions
+- Added virtio\_net User Networking mode by default and removed instructions
   about tap networking setup.
 - Updated Linux kernel version from 5.10 to 5.14 for both standard and
   Real-Time (PREEMPT\_RT) builds.
-- Enabled SMP support via boot-wrapper-aarch64 providing the PSCI CPU_ON and
-  CPU_OFF functions.
+- Enabled SMP support via boot-wrapper-aarch64 providing the PSCI CPU\_ON and
+  CPU\_OFF functions.
 - Introduced Armv8-R64 compiler flags.
 - Added Linux PREEMPT\_RT support via linux-yocto-rt-5.10.
 - Added support for file sharing with the host machine using Virtio P9.