Wrap README lines for easier non-rendered reading.
Change-Id: Iacb4945260b718957407d99fe74d20bf58bc342a
diff --git a/README.md b/README.md
index 276e657..cd1ce83 100644
--- a/README.md
+++ b/README.md
@@ -14,16 +14,22 @@
## Building
### One-time setup
-You will need a cross-compilation toolchain, for example, `aarch64-linux-gnu`, which can be installed with `apt-get` using the following command-line:
+You will need a cross-compilation toolchain, for example, `aarch64-linux-gnu`,
+which can be installed with `apt` using the following command-line:
+
``` shell
-sudo apt-get install gcc-aarch64-linux-gnu
+sudo apt install gcc-aarch64-linux-gnu
```
-Makefiles use the `CROSS_COMPILE` variable to specify the prefix of the tools; in the case above it is `aarch64-linux-gnu-` (note the trailing dash). In the examples that follow, we will assume that this toolchain is installed and available for use.
+Makefiles use the `CROSS_COMPILE` variable to specify the prefix of the tools;
+in the case above it is `aarch64-linux-gnu-` (note the trailing dash). In the
+examples that follow, we will assume that this toolchain is installed and
+available for use.
### Compiling the hypervisor
-The hypervisor proper is in the `hafnium` subdirectory. It can be built for QEMU using the following command:
+The hypervisor proper is in the `hafnium` subdirectory. It can be built for QEMU
+using the following command:
``` shell
CROSS_COMPILE=aarch64-linux-gnu- make
@@ -33,13 +39,17 @@
## Running on QEMU
-You will need at least version 2.9 for QEMU. The following command line can be used to run Hafnium on it:
+You will need at least version 2.9 for QEMU. The following command line can be
+used to run Hafnium on it:
``` shell
qemu-system-aarch64 -M virt -cpu cortex-a57 -nographic -machine virtualization=true -kernel out/aarch64/qemu/hafnium.bin
```
-Though it is admittedly not very useful because it doesn't have any virtual machines to run. The next sections describe how to build an image that can be run using the following command-line:
+Though it is admittedly not very useful because it doesn't have any virtual
+machines to run. The next sections describe how to build an image that can be
+run using the following command-line:
+
``` shell
qemu-system-aarch64 -M virt -cpu cortex-a57 -nographic -machine virtualization=true -kernel out/aarch64/qemu/hafnium.bin -initrd initrd.img -append "rdinit=/sbin/init"
```
@@ -55,11 +65,15 @@
### Format of `vms.txt` file
The format is currently one line per secondary VM, with the following format:
+
``` shell
<memory-size-in-bytes> <number-of-cpus> <kernel-filename>
```
-For example, the following defines two secondary VMs, the first one with 1MB of memory, 2 CPUs and kernel image called `kernel0`, while the second one has 2MB of memory, 4 CPUs and a kernel image called `kernel1`.
+For example, the following defines two secondary VMs, the first one with 1MB of
+memory, 2 CPUs and kernel image called `kernel0`, while the second one has 2MB
+of memory, 4 CPUs and a kernel image called `kernel1`.
+
``` shell
1048576 2 kernel0
2097152 4 kernel1
@@ -67,8 +81,10 @@
### Creating a hafnium RAM disk
-Assuming that a subdirectory called `initrd` contains the files listed in the previous section, we can build `initrd.img` with the following command:
-``` shell
+Assuming that a subdirectory called `initrd` contains the files listed in the
+previous section, we can build `initrd.img` with the following command:
+
+```shell
cd initrd; find . | cpio -o > ../initrd.img; cd -
```
@@ -76,7 +92,9 @@
### Kernel
-The linux kernel for the primary VM can be built using the following command-line:
+The linux kernel for the primary VM can be built using the following
+command-line:
+
``` shell
git clone https://github.com/torvalds/linux.git
cd linux
@@ -84,11 +102,13 @@
ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make -j24
```
-The compiled image is stored in `arch/arm64/boot/Image`. This should be copied to the Hafnium ramdisk's root as `vmlinuz`.
+The compiled image is stored in `arch/arm64/boot/Image`. This should be copied
+to the Hafnium ramdisk's root as `vmlinuz`.
### Busybox RAM disk
-An initial ramdisk for the primary VM containing busybox can be built with the following commands:
+An initial ramdisk for the primary VM containing busybox can be built with the
+following commands:
``` shell
git clone git://busybox.net/busybox.git
@@ -97,7 +117,8 @@
ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make menuconfig
```
-At this point you should ensure that the option `Build static binary (no shared libs)` under `Settings` is selected. Then you can proceed with the following commands:
+At this point you should ensure that the option `Settings > Build static binary
+(no shared libs)` is selected. Then you can proceed with the following commands:
``` shell
ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make -j24
@@ -117,4 +138,5 @@
cd -
```
-The resulting file is `initrd.img`. It should be copied to the Hafnium ramdisk's root.
+The resulting file is `initrd.img`. It should be copied to the Hafnium ramdisk's
+root.
