From 86ad5dc1f589d78053eeaa7054dd5a4e5d606422 Mon Sep 17 00:00:00 2001 From: Helmut Grohne Date: Fri, 23 Dec 2022 22:55:37 +0100 Subject: improve documentation wording and content Reported-by: Johannes Schauer Marin Rodrigues --- debvm-create | 6 +++--- 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 [B<-a> I] [B<-h> I] [B<-k> I] [B =head1 DESCRIPTION B is essentially a thin wrapper around B for creating a raw ext4 filesystem image for booting with B. -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, 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. =item B<-p> I 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 diff --git a/debvm-run b/debvm-run index 729ba6d..cb782db 100755 --- a/debvm-run +++ b/debvm-run @@ -13,7 +13,7 @@ B [B<-g>] [B<-i> I] [B<-s> I] [B<--> I] =head1 DESCRIPTION -B is essentially a thing wrapper around B for running a virtual machine image created by B or something compatible. +B is essentially a thin wrapper around B for running a virtual machine image created by B or something compatible. The virtual machine image is expected to be a raw ext4 image with file system label B. The architecture of the machine is detected from the contained B. It must contain a symbolic link pointing to a kernel image at B or B depending on the architecture and a symbolic link pointing to an initrd image at B. @@ -42,14 +42,16 @@ If given, B is configured to pass connections to I<127.0.0.1:sshport> to p All options beyond a double dash are passed to B. 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, one cannot upgrade a kernel and then just reboot. +Attempting to do so, will still use the old kernel. Instead, B must be terminated and B should be launched again to pick up a new kernel. +In order to avoid accidental reboots, one may pass B<-no-reboot> to B. =head1 SEE ALSO -- cgit v1.2.3