diff options
author | Helmut Grohne <helmut@subdivi.de> | 2022-12-23 22:55:37 +0100 |
---|---|---|
committer | Helmut Grohne <helmut@subdivi.de> | 2022-12-23 22:55:37 +0100 |
commit | 86ad5dc1f589d78053eeaa7054dd5a4e5d606422 (patch) | |
tree | b45821c757e2d4a942124bc09458ff207f6837dc | |
parent | 9aa4cb7de93569c35994faea051b9e390da25008 (diff) | |
download | debvm-86ad5dc1f589d78053eeaa7054dd5a4e5d606422.tar.gz |
improve documentation wording and content
Reported-by: Johannes Schauer Marin Rodrigues <josch@mister-muffin.de>
-rwxr-xr-x | debvm-create | 6 | ||||
-rwxr-xr-x | debvm-run | 8 |
2 files changed, 8 insertions, 6 deletions
diff --git a/debvm-create b/debvm-create index 5fc8950..65b3c54 100755 --- a/debvm-create +++ b/debvm-create @@ -16,9 +16,9 @@ B<debvm-create> [B<-a> I<architecture>] [B<-h> I<hostname>] [B<-k> I<sshkey>] [B =head1 DESCRIPTION B<debvm-create> is essentially a thin wrapper around B<mmdebstrap> for creating a raw ext4 filesystem image for booting with B<debvm-run>. -The purpose of these images primarily is testing the different releases and architectures. +The purpose of these images primarily is testing the different releases and architectures without access to a physical machine of that architecture. Beyond essential packages, the image will contain B<apt>, an init system and a suitable kernel package. -Notably absent is a bootloader and partition table. +Notably absent is a bootloader and a partition table. In order to boot such an image, one is supposed to extract the kernel and initrd from the image and pass it to a suitable bootloader. No user account is created and root can login without specifying a password. @@ -56,7 +56,7 @@ By default, it is written to B<rootfs.ext4>. =item B<-p> I<package> Request additional packages to be installed into the virtual machine image. -This option can be specified multiple times and packages can be separated with comma. +This option can be specified multiple times and packages can be separated by a comma. Package recommendations are not honoured. =item B<-r> I<release> @@ -13,7 +13,7 @@ B<debvm-run> [B<-g>] [B<-i> I<image>] [B<-s> I<sshport>] [B<--> I<qemu options>] =head1 DESCRIPTION -B<debvm-run> is essentially a thing wrapper around B<qemu> for running a virtual machine image created by B<debvm-create> or something compatible. +B<debvm-run> is essentially a thin wrapper around B<qemu> for running a virtual machine image created by B<debvm-create> or something compatible. The virtual machine image is expected to be a raw ext4 image with file system label B<debvm>. The architecture of the machine is detected from the contained B</bin/true>. It must contain a symbolic link pointing to a kernel image at B</vmlinuz> or B</vmlinux> depending on the architecture and a symbolic link pointing to an initrd image at B</initrd.img>. @@ -42,14 +42,16 @@ If given, B<qemu> is configured to pass connections to I<127.0.0.1:sshport> to p All options beyond a double dash are passed to B<qemu>. This can be used to configure additional hardware components. -Another use of this method is passing B<-snapshot> to avoid modifying the virtual machine image. +One possible use of this method is passing B<-snapshot> to avoid modifying the virtual machine image. =back =head1 LIMITATIONS -Due to the way kernel and bootloader are being extracted before running qemu, one cannot upgrade a kernel and then just reboot. +Due to the way kernel and bootloader are being extracted before running B<qemu>, one cannot upgrade a kernel and then just reboot. +Attempting to do so, will still use the old kernel. Instead, B<qemu> must be terminated and B<debvm-run> should be launched again to pick up a new kernel. +In order to avoid accidental reboots, one may pass B<-no-reboot> to B<qemu>. =head1 SEE ALSO |