grub-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] docs: Add fuller accounting of make check prerequisites


From: Glenn Washburn
Subject: [PATCH] docs: Add fuller accounting of make check prerequisites
Date: Tue, 28 Sep 2021 18:52:55 -0500

Many of the prerequisites for exercising the full `make check' test suite
have not been documented. This adds them along with a note that some tests
require elevated privileges to run.

Signed-off-by: Glenn Washburn <development@efficientek.com>
---
 INSTALL | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/INSTALL b/INSTALL
index 5e152b71f..25e3740ff 100644
--- a/INSTALL
+++ b/INSTALL
@@ -48,8 +48,27 @@ need the following.
 
 Prerequisites for make-check:
 
-* qemu, specifically the binary 'qemu-system-i386'
+* qemu, specifically the binary 'qemu-system-ARCH' where ARCH is the
+  architecture GRUB has been built for
+* OVMF, for EFI platforms
+* OpenBIOS, for ieee1275 platforms
 * xorriso 1.2.9 or later, for grub-mkrescue and grub-shell
+* wamerican, for grub-fs-tester
+* mtools, FAT tools for EFI platforms
+
+* If running a Linux kernel the following modules must be loaded:
+  - minix, hfs, mac-roman, hfsplus, exfat, reiserfs, xfs, f2fs, btrfs,
+    nilfs2, jfs, fat, ext4, udf, romfs, isofs, squashfs
+* The following are debian named packages required mostly for the full
+  suite of filesystem testing (but some are needed by other tests as well
+  - tar, cpio, gzip, lzop, xz-utils, parted, util-linux, squashfs-tools,
+    zfs-fuse, dosfstools, exfat-utils, ntfs-3g, e2fsprogs, btrfs-progs,
+    xfsprogs, hfsprogs, recode, jfsutils, reiserfsprogs, udftools,
+    nilfs-tools, f2fs-tools, genromfs, attr
+
+Note that `make check' will run and many tests may complete successfully
+with only a subset of these prerequisites. However, some tests may be
+skipped or fail due to missing prerequisites.
 
 Configuring the GRUB
 ====================
@@ -101,7 +120,8 @@ The simplest way to compile this package is:
   6. Type `make' to compile the package.
 
   7. Optionally, type `make check' to run any self-tests that come with
-     the package.
+     the package.  Note that many of the tests require root privileges in
+     order to run.
 
   8. Type `make install' to install the programs and any data files and
      documentation.
-- 
2.27.0




reply via email to

[Prev in Thread] Current Thread [Next in Thread]