Hi all,

I asked someone to run "make check".  He pointed out that it wasn't
documented what this does, exactly (is it really completely undocumented?).
I think we should mention "make check" in the README.  Here's a
quick writeup what make check does, with its pitfalls.  Feel free
to improve the wording.

This doesn't necessarily have to go into 4.8.0, but since it's a
nontechnical change I don't see any reason not to merge it in.

Cheers,
Peter
-- 
http://sjamaan.ath.cx
--
"The process of preparing programs for a digital computer
 is especially attractive, not only because it can be economically
 and scientifically rewarding, but also because it can be an aesthetic
 experience much like composing poetry or music."
                                                        -- Donald Knuth
>From 5234793b42fcdb0dfa345a96903b0d5439d35942 Mon Sep 17 00:00:00 2001
From: Peter Bex <[email protected]>
Date: Sun, 9 Sep 2012 14:05:02 +0200
Subject: [PATCH] Add 'make check' description

---
 README |   22 +++++++++++++++++++---
 1 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/README b/README
index 730ef4c..27f1c47 100644
--- a/README
+++ b/README
@@ -131,7 +131,23 @@
         It designates the directory where the files are installed
         into.
 
-    2.4. Optional features
+    2.4. Verifying your installation is correct
+
+        You can check whether Chicken is functioning correctly by
+        running
+
+            make PLATFORM=<platform> PREFIX=<destination> check
+
+        This will run the test scripts, which show a lot of output.
+        The only thing that matters is the exit status at the end.
+        If it exits with status 0, everything is fine, if it exits
+        with a nonzero status, the failing test's output should be
+        the final lines before Make's "error; exit" output.  If the
+        check fails on unmodified sources, please file a bugreport.
+
+        Currently "make check" only works if you have installed Chicken.
+
+    2.5. Optional features
 
         You can further enable various optional features by adding
         one or more of the following variables to the "make"
@@ -225,7 +241,7 @@
          Be warned that this is a highly experimental option and
          profiling doesn't work for every component of Chicken.
 
-    2.5. Uninstalling Chicken
+    2.6. Uninstalling Chicken
 
         To remove CHICKEN from your file-system, enter (probably as
         root):
@@ -235,7 +251,7 @@
         (If you gave DESTDIR during installation, you have to pass
         the same setting to "make" when uninstalling)
 
-    2.6. What gets installed
+    2.7. What gets installed
 
        These files will be installed under the prefix given during
        build and installation:
-- 
1.7.9.1

_______________________________________________
Chicken-hackers mailing list
[email protected]
https://lists.nongnu.org/mailman/listinfo/chicken-hackers

Reply via email to