]> git.ipfire.org Git - thirdparty/grub.git/commitdiff
docs: Update development docs to include information on running test suite
authorGlenn Washburn <development@efficientek.com>
Fri, 5 Nov 2021 19:12:56 +0000 (14:12 -0500)
committerDaniel Kiper <daniel.kiper@oracle.com>
Wed, 22 Dec 2021 23:52:36 +0000 (00:52 +0100)
Add a section with minimal description on setting up and running the test
suite with a link to the INSTALL documentation which is a little more
detailed in terms of package requirements.

Signed-off-by: Glenn Washburn <development@efficientek.com>
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
docs/grub-dev.texi

index fb2cc965ed8046e98c62fecc58f3ff0255eaacc3..cd59da66c0343f2a0f01f833d15f819c123472ee 100644 (file)
@@ -77,6 +77,7 @@ This edition documents version @value{VERSION}.
 * Coding style::
 * Finding your way around::
 * Contributing Changes::
+* Setting up and running test suite::
 * Updating External Code::
 * Porting::
 * Error Handling::
@@ -483,6 +484,17 @@ If your intention is to just get started, please do not submit a inclusion
 request. Instead, please subscribe to the mailing list, and communicate first
 (e.g. sending a patch, asking a question, commenting on another message...).
 
+@node Setting up and running test suite
+@chapter Setting up and running test suite
+
+GRUB is basically a tiny operating system with read support for many file
+systems and which has been ported to a variety of architectures. As such, its
+test suite has quite a few dependencies required to fully run the suite.
+These dependencies are currently documented in the
+@uref{https://git.savannah.gnu.org/cgit/grub.git/tree/INSTALL, INSTALL}
+file in the source repository. Once installed, the test suite can be started
+by running the @command{make check} command from the GRUB build directory.
+
 @node Updating External Code
 @chapter Updating external code