From: Russ Allbery <rra@stanford.edu>
Date: Tue, 15 Aug 2006 22:27:17 +0000 (+0000)
Subject: Document prerequisites for make check
X-Git-Tag: krb5-1.6-alpha1~176
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=77afe31c1470a91cff10ed03bb8a104ba7a8a8f4;p=krb5.git

Document prerequisites for make check

Document the prerequisites for running make check, since some of them are
a bit surprising.

Ticket: new
Component: krb5-doc
Tags: pullup
Version_Reported: 1.5
Target_Version: 1.5.1

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@18441 dc483132-0cff-0310-8789-dd5450dbe970
---

diff --git a/doc/build.texinfo b/doc/build.texinfo
index 8e7aed92c..f92a4d249 100644
--- a/doc/build.texinfo
+++ b/doc/build.texinfo
@@ -387,6 +387,29 @@ building Kerberos; see @ref{Doing the Build}.):
 % make check
 @end example
 
+However, there are several prerequisites that must be satisfied first:
+
+@itemize @bullet
+@item
+Configure and build Kerberos with Tcl support.  Tcl is used to drive the
+test suite.  This often means passing @code{--with-tcl} to configure to
+tell it the location of the Tcl configuration script.  (See
+@xref{Options to Configure}.)
+
+@item
+You have to run @samp{make install} before running @samp{make check}, or
+the test suite will often pick up the installed version of Kerberos
+rather than the newly built one.  You can install into a prefix that
+isn't in the system library search path, though.  This theoretically
+could be fixed with the appropriate environment variable magic in the
+test suite, but hasn't been yet.
+
+@item
+In order to test the RPC layer, the local system has to be running the
+@command{portmap} daemon and it has to be listening to the regular
+network interface (not just localhost).
+@end itemize
+
 @menu
 * The DejaGnu Tests::           
 * The KADM5 Tests::