resources: Add some details to boot-exit readme
This change adds some info about possible packer errors and how to solve
them. Additionally, it fixes a typo in a filename in the description of
this directory.
Change-Id: Ifc7d68efd2a0b97dfe7cafcc57bca203254ab6a9
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-resources/+/32334
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Reviewed-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: Bobby R. Bruce <bbruce@ucdavis.edu>
diff --git a/src/boot-exit/README.md b/src/boot-exit/README.md
index be6932e..d5c2b6c 100755
--- a/src/boot-exit/README.md
+++ b/src/boot-exit/README.md
@@ -20,7 +20,7 @@
|
|___ configs
| |___ system # gem5 system config files
- | |___ run_spec.py # gem5 run script
+ | |___ run_exit.py # gem5 run script
|
|___ linux-configs # Folder with Linux kernel configuration files
|
@@ -54,6 +54,28 @@
./packer build boot-exit/boot-exit.json
```
+If you see errors or warnings from `packer validate` you can modify the file `disk-image/boot-exit/boot-exit.json` to update the file.
+Specifically, you may see the following error.
+
+```
+Error: Failed to prepare build: "qemu"
+
+1 error(s) occurred:
+
+* Bad source '../gem5/util/m5/build/x86/out/m5': stat
+../gem5/util/m5/build/x86/out/m5: no such file or directory
+```
+
+In this case, the `gem5` directory is in a different location than when this script was written.
+You can update the following line in the `boot-exit.json` file.
+
+```
+ "destination": "/home/gem5/",
+- "source": "../gem5/util/m5/build/x86/out/m5",
++ "source": "<your path to gem5>/util/m5/build/x86/out/m5",
+ "type": "file"
+```
+
Once this process succeeds, the disk image can be found on `boot-exit/boot-exit-image/boot-exit`.
A disk image already created following the above instructions can be found [here](http://dist.gem5.org/images/x86/ubuntu-18-04/boot-exit) (**warning:** file size is 1.9 GB).
