From d7b0db13a584f24730024bf6f7ca0c9e03b259b9 Mon Sep 17 00:00:00 2001 From: Brian Woods Date: Thu, 24 Oct 2019 20:32:04 -0700 Subject: Add command line arguments for disk_image Add some simple command line arguments and some dependency checking that makes running the script outside of a container much easier. Signed-off-by: Brian Woods Signed-off-by: Stefano Stabellini Reviewed-by: Stefano Stabellini --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 3e7f39f..98da5e8 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,31 @@ Where:\ arbitrary command can be used, for instance -t "fatload" is valid.\ +## Stand-alone Usage: scripts/disk\_image + +The ImageBuilder script that generates a disk image file to load on a +SD or SATA drive. This creates 2 partitions: boot partition where the +boot files from working directory (-c option) are, and the dom0 ramdisk +uncompressed into the root FS partition. + +After you've generated the u-boot scripts using the uboot-script-gen +script, disk_image is run as follows: + +``` +$ sudo bash ./scripts/disk_image -c /path/to/config-file -d . \ + -w /path/to/tmp/dir \ + -o /path/to/output/disk.img +``` + +Where:\ +-c specifies the path to the config file to use\ +-d specifies the working directory (paths in the config file are relative + to it)\ +-w specifies the temporary working directory that the script uses for + building the disk image, and if not set, one is created in /tmp\ +-o specifies the output disk image file name\ + + ## Container Usage ImageBuilder comes with a Dockerfile to build a container with all the -- cgit v1.2.3