toolchain/dejagnu/README

   1 DejaGnu is a framework for testing other programs. Its purpose is to
   2 provide a single front end for all tests.  Beyond this, DejaGnu offers
   3 several advantages for testing:
   4
   5         - The flexibility and consistency of the DejaGnu framework
   6           make it easy to write tests for any program.
   7
   8         - DejaGnu provides a layer of abstraction which makes all
   9           tests (if correctly written) portable to any host or target
  10           where a program must be tested.  For instance, a test for
  11           GDB can run (from any Unix based host) on any target
  12           architecture supported by DejaGnu. Currently DejaGnu runs
  13           tests on several single board computers, whose operating
  14           software ranges from just a boot monitor to a full-fledged,
  15           Unix-like realtime OS.
  16
  17         - DejaGnu is written in expect, which in turn uses Tcl
  18           (Tool command language).  The framework comprises two parts:
  19           the testing framework and the testsuites themselves. Tests
  20           are usually written in expect using Tcl.
  21
  22 If you think you have found a bug in DejaGnu, then please send a bug
  23 report according to the guidelines outlined at:
  24
  25         <http://www.gnu.org/software/dejagnu/#bug>
  26
  27
  28                       How To Configure and Build
  29
  30  To build DejaGnu, run the ``configure'' script here, e.g.:
  31
  32         ./configure MYHOSTTYPE
  33
  34 followed by running ``make''.  (MYHOSTTYPE is a name for your host computer,
  35 for instance "sun4".  You can use the script ``config.sub'' to test whether
  36 a name is recognized; if it is, config.sub translates it to a triplet
  37 specifying CPU, vendor, and OS.) This is used when you plan to
  38 configure and build in the source tree.
  39
  40   If you use a separate tree for object files, (the recommended way),
  41 then the --srcdir option must also be specified. This would also
  42 require that the configure script be run from the top level directory.
  43
  44         PATH/configure MYHOSTYPE
  45
  46 where PATH is is the directory that the contains the sources.
  47
  48   To configure it so it gets installed somewhere other than the
  49 default of /usr/local, use the --prefix option.
  50
  51         configure MYHOSTYPE --prefix [PATH]
  52
  53 where PATH is the prefix used to install the programs.
  54
  55   The configure testing and building will use the native compiler "cc"
  56 on your host machine. To change which compiler gets used (like gcc)
  57 set a the variable "CC" in your environment to point to it.
  58
  59         For csh users:          "setenv CC gcc"
  60         For bourne shell users: "CC=gcc;export CC"
  61
  62   Then when you compile, use "make CC=$CC".
  63
  64 See /usr/doc/dejagnu-$version/overview/book1.html or
  65 /usr/doc/dejagnu-$version/overview.ps for  for more details.
  66
  67  As DejaGnu is a Tcl program, there is little to build. However, the
  68 documentation is not built by default. Use these targets:
  69 "make overview.html" - Generate the html formatted documentation from
  70                   the SGML source.
  71 "make overview.ps" - Generate the Postscript formatted documentation from
  72                   the SGML source.
  73 "make overview.pdf" - Generate the PDF formatted documentation from
  74                   the SGML source.
  75 "make install"  - This installs DejaGnu based on the --prefix option
  76                   when configuring. Otherwise it defaults to
  77                   /usr/local. See the DejaGnu manual for more
  78                   information on installation.