diff options
author | Rob Savoye <rob@welcomehome.org> | 2001-02-22 05:47:34 +0000 |
---|---|---|
committer | Rob Savoye <rob@welcomehome.org> | 2001-02-22 05:47:34 +0000 |
commit | ede24ea38c0307cefb5c0d8d1d92ab40164ce714 (patch) | |
tree | 174c9222fc2fe568df6fec9d85f0a622a25cfc14 /doc | |
parent | d1796b46df0f70ddb14b62013d88d2292995c7f1 (diff) | |
download | dejagnu-ede24ea38c0307cefb5c0d8d1d92ab40164ce714.zip dejagnu-ede24ea38c0307cefb5c0d8d1d92ab40164ce714.tar.gz dejagnu-ede24ea38c0307cefb5c0d8d1d92ab40164ce714.tar.bz2 |
* debian/changelog: Add entry for new release.
* debian/control: Fix problem with "no binary package" error.
* debian/rules: Fix so things actually build a package. This was
mostly installing the new html version of the doc, not an info
page.
* doc/Makefile.am: Build and install the rtf and ps versions
of the manual. Remove all the created files and subdirectories.
* doc/overview.sgml: Update the copyright message.
* doc/ref.sgml: Update the copyright messages. Add section on
obtaining DejaGnu releases.
* doc/user.sgml: Update the copyright messages. Add blurb about
the --mail option.
* doc/overview: Regenerated.
Diffstat (limited to 'doc')
33 files changed, 639 insertions, 513 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 6e367d5..68e05f4 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -3,7 +3,7 @@ # AUTOMAKE_OPTIONS = DOCBOOK = @DOCBOOK@ -TARGETS = overview.html overview.rtf # overview.dvi overview.ps +TARGETS = overview.html overview.rtf overview.ps # overview.pdf overview.dvi docs: $(TARGETS) @@ -36,11 +36,14 @@ docs: $(TARGETS) html rtf overview.pdf overview.ps overview.dvi overview.rtf overview.html: overview.sgml ref.sgml user.sgml -clean: - rm -f $(TARGETS) +clean realclean distclean: + rm -fr $(TARGETS) DBHTOHTML* overview.junk overview.{aux,dvi,log} install-doc: $(TARGETS) - $(mkinstalldirs) $(DESTDIR)$(pkgdatadir)/html + $(mkinstalldirs) $(DESTDIR)$(pkgdatadir)/html $(DESTDIR)$(pkgdatadir)/html/stylesheet-images $(INSTALL_DATA) overview/*.html $(DESTDIR)$(pkgdatadir)/html -# $(INSTALL_DATA) overview.ps $(DESTDIR)$(pkgdatadir)/dejagnu.ps + $(INSTALL_DATA) overview/stylesheet-images/*.png $(DESTDIR)$(pkgdatadir)/html/stylesheet-images + $(INSTALL_DATA) overview.rtf $(DESTDIR)$(pkgdatadir)/dejagnu.ps + $(INSTALL_DATA) overview.ps $(DESTDIR)$(pkgdatadir)/dejagnu.ps # $(INSTALL_DATA) overview.pdf $(DESTDIR)$(pkgdatadir)/dejagnu.pdf + diff --git a/doc/Makefile.in b/doc/Makefile.in index 0666f86..2938945 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -71,7 +71,7 @@ VERSION = @VERSION@ tclsh = @tclsh@ DOCBOOK = @DOCBOOK@ -TARGETS = overview.html overview.rtf # overview.dvi overview.ps +TARGETS = overview.html overview.rtf overview.ps # overview.pdf overview.dvi mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs CONFIG_CLEAN_FILES = DIST_COMMON = README Makefile.am Makefile.in configure configure.in @@ -206,13 +206,15 @@ docs: $(TARGETS) html rtf overview.pdf overview.ps overview.dvi overview.rtf overview.html: overview.sgml ref.sgml user.sgml -clean: - rm -f $(TARGETS) +clean realclean distclean: + rm -fr $(TARGETS) DBHTOHTML* overview.junk overview.{aux,dvi,log} install-doc: $(TARGETS) - $(mkinstalldirs) $(DESTDIR)$(pkgdatadir)/html + $(mkinstalldirs) $(DESTDIR)$(pkgdatadir)/html $(DESTDIR)$(pkgdatadir)/html/stylesheet-images $(INSTALL_DATA) overview/*.html $(DESTDIR)$(pkgdatadir)/html -# $(INSTALL_DATA) overview.ps $(DESTDIR)$(pkgdatadir)/dejagnu.ps + $(INSTALL_DATA) overview/stylesheet-images/*.png $(DESTDIR)$(pkgdatadir)/html/stylesheet-images + $(INSTALL_DATA) overview.rtf $(DESTDIR)$(pkgdatadir)/dejagnu.ps + $(INSTALL_DATA) overview.ps $(DESTDIR)$(pkgdatadir)/dejagnu.ps # $(INSTALL_DATA) overview.pdf $(DESTDIR)$(pkgdatadir)/dejagnu.pdf # Tell versions [3.59,3.63) of GNU make to not export all variables. diff --git a/doc/overview.sgml b/doc/overview.sgml index 4d86d25..32b4b2e 100644 --- a/doc/overview.sgml +++ b/doc/overview.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ <!-- Begin Document Specific Declarations --> @@ -8,14 +8,14 @@ <!ENTITY dj "DejaGnu"> <!ENTITY dejagnu-copyright " - <YEAR>2000</YEAR> + <YEAR>2001</YEAR> <HOLDER>Free Software Foundation, Inc.</HOLDER>"> <!ENTITY dejagnu-code-copyright " %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% This file documents the GNU Testing Framework ``DejaGnu'' -Copyright (C) 92, 93, 94, 95, 96, 97, 98, 99, 2000 Free Software +Copyright (C) 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. This text may be freely distributed under the terms of the GNU @@ -24,7 +24,7 @@ General Public License. "> <!ENTITY dejagnu-copyright " -Copyright 92, 93, 94, 95, 96, 97, 98, 99, 2000 Free Software +Copyright 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of @@ -47,13 +47,14 @@ into another language, under the above conditions for modified versions. <!entity user SYSTEM "user.sgml"> <!-- End Document Specific Declarations --> + ]> <book> <bookinfo> <title>&dj;</title> <subtitle>The GNU Testing Framework</subtitle> - <date>2000 Jan 24</date> + <date>2001 Feb 16</date> <edition> &version</edition> <releaseinfo> for circulation within Cygnus</releaseinfo> <authorgroup> @@ -85,6 +86,12 @@ into another language, under the above conditions for modified versions. <!-- </legalnotice> --> <revhistory> <revision> + <revnumber>0.6</revnumber> + <date>2001-2-16</date> + <authorinitials>rob@welcomehome.org</authorinitials> + <revremark>Updated for new release.</revremark> + </revision> + <revision> <revnumber>0.5</revnumber> <date>2000-1-24</date> <authorinitials>rob@welcomehome.org</authorinitials> @@ -237,13 +244,13 @@ into another language, under the above conditions for modified versions. <title>NT Support</title> <para>To use DejaGnu on NT, you need to first install the - <ulink URL="http://sources.redhat.com">Cygwin</ulink> + <ulink URL="http://sources.redhat.com/cygwin">Cygwin</ulink> release. This works as of the B20.1 release. Cygwin is a POSIX system for NT. This covers both utility programs, and a libray that adds POSIX system calls to NT. Among them is pseudo tty support for NT that emulates the POSIX pty standard. The latest Cygwin is always available from <ulink - URL="http://sources.redhat.com">this location</ulink>. This + URL="http://sources.redhat.com/cygwin">this location</ulink>. This works well enough to run <emphasis>"make check"</emphasis> of the GNU development tree on NT after a native build. But the nature of pty's on NT is still evolving. Your mileage may @@ -257,21 +264,22 @@ into another language, under the above conditions for modified versions. <title>Design Goals</title> <para>DejaGnu grew out of the internal needs of Cygnus Solutions. (then - Cygnus Support). Cygnus maintains and enhances a variety of free programs - in many different environments, and we needed a testing tool that:</para> + Cygnus Support). Cygnus maintained and enhanced a variety of free + programs in many different environments, and we needed a testing + tool that:</para> <itemizedlist mark="bullet"> - <listitem><para>is useful to developers while fixing + <listitem><para>was useful to developers while fixing bugs.</para></listitem> - <listitem><para>automates running many tests during a software + <listitem><para>automated running many tests during a software release process.</para></listitem> - <listitem><para>is portable among a variety of host + <listitem><para>was portable among a variety of host computers.</para></listitem> - <listitem><para>supports cross-development + <listitem><para>supported cross-development testing.</para></listitem> - <listitem><para>permits testing interactive programs, like + <listitem><para>permited testing interactive programs, like <command>GDB</command>; and </para></listitem> - <listitem><para>permits testing batch oriented programs, like + <listitem><para>permited testing batch oriented programs, like <command>GCC</command>.</para></listitem> </itemizedlist> @@ -451,3 +459,21 @@ into another language, under the above conditions for modified versions. &ref; </book> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-namecase-general:t +sgml-general-insert-case:lower +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:nil +sgml-parent-document:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> diff --git a/doc/overview/addboard.html b/doc/overview/addboard.html index 37463c7..786bcdf 100644 --- a/doc/overview/addboard.html +++ b/doc/overview/addboard.html @@ -4,7 +4,7 @@ >Adding A New Board</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -96,15 +96,11 @@ CLASS="FILENAME" you can include one board file into another, The two main procedures used to do this are <TT CLASS="FUNCTION" -><B ->load_generic_config</B -></TT +>load_generic_config</TT > and <TT CLASS="FUNCTION" -><B ->load_base_board_description</B -></TT +>load_base_board_description</TT >. The generic config file contains other procedures used for a certain class of target. The board description file is where the board specfic settings go. Commonly diff --git a/doc/overview/adding.html b/doc/overview/adding.html index cac339d..fb6ff34 100644 --- a/doc/overview/adding.html +++ b/doc/overview/adding.html @@ -4,7 +4,7 @@ >Adding A Test Case To A Test Suite.</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/addtarget.html b/doc/overview/addtarget.html index 609a6ac..9de60c4 100644 --- a/doc/overview/addtarget.html +++ b/doc/overview/addtarget.html @@ -4,7 +4,7 @@ >Adding A New Target</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -83,9 +83,7 @@ NAME="ADDTARGET" >When you code an initialization module, be generous in printing information controlled by the <TT CLASS="FUNCTION" -><B ->verbose</B -></TT +>verbose</TT > procedure.</P ><P diff --git a/doc/overview/addtool.html b/doc/overview/addtool.html index a5f7330..4f2b8a6 100644 --- a/doc/overview/addtool.html +++ b/doc/overview/addtool.html @@ -4,7 +4,7 @@ >Adding A New Tool</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/boardconfig.html b/doc/overview/boardconfig.html index 95d6643..234e20d 100644 --- a/doc/overview/boardconfig.html +++ b/doc/overview/boardconfig.html @@ -4,7 +4,7 @@ >Board Config File</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -82,9 +82,7 @@ HREF="addboard.html" >An example board config file for a GNU simulator is as follows. <TT CLASS="FUNCTION" -><B ->set_board_info</B -></TT +>set_board_info</TT > is a procedure that sets the field name to the specified value. The procedures in square brackets <I @@ -152,24 +150,18 @@ CLASS="PROGRAMLISTING" >There are five helper procedures used in this example. The first one, <TT CLASS="FUNCTION" -><B ->find gcc</B -></TT +>find gcc</TT > looks for a copy of the GNU compiler in your build tree, or it uses the one in your path. This will also return the proper transformed name for a cross compiler if you whole build tree is configured for one. The next helper procedures are <TT CLASS="FUNCTION" -><B ->libgloss_include_flags</B -></TT +>libgloss_include_flags</TT > & <TT CLASS="FUNCTION" -><B ->libgloss_link_flags</B -></TT +>libgloss_link_flags</TT >. These return the proper flags to compiler and link an executable image using <A HREF="builtins.html#LIBGLOSS" @@ -179,15 +171,11 @@ HREF="builtins.html#LIBGLOSS" >, the GNU BSP (Board Support Package). The final procedures are <TT CLASS="FUNCTION" -><B ->newlib_include_flag</B -></TT +>newlib_include_flag</TT > & <TT CLASS="FUNCTION" -><B ->newlib_include_flag</B -></TT +>newlib_include_flag</TT >. These find the Newlib C library, which is a reentrant standard C library for embedded systems comprising of non GPL'd code.</P diff --git a/doc/overview/boarddefs.html b/doc/overview/boarddefs.html index d89694c..08ccbc5 100644 --- a/doc/overview/boarddefs.html +++ b/doc/overview/boarddefs.html @@ -4,7 +4,7 @@ >Board Config File Values</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -73,9 +73,7 @@ CLASS="SYMBOL" > These are all set by using the <TT CLASS="FUNCTION" -><B ->set_board_info</B -></TT +>set_board_info</TT > procedure. The parameters are the field name, followed by the value to set the field to.</P diff --git a/doc/overview/book1.html b/doc/overview/book1.html index 68347e0..9fa0814 100644 --- a/doc/overview/book1.html +++ b/doc/overview/book1.html @@ -4,7 +4,7 @@ >DejaGnu</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="NEXT" TITLE="Abstract" HREF="preface.html"></HEAD @@ -36,7 +36,7 @@ CLASS="ORGNAME" ></DIV ><P CLASS="COPYRIGHT" ->Copyright © 2000 by <SPAN +>Copyright © 2001 by <SPAN CLASS="HOLDER" >Free Software Foundation, Inc.</SPAN ></P @@ -269,19 +269,24 @@ HREF="reference.html" ><DL ><DT ><A -HREF="reference.html#INSTALLATION" +HREF="reference.html#OBTAINING" +>Obtaining DejaGnu</A +></DT +><DT +><A +HREF="installation.html" >Installation</A ></DT ><DD ><DL ><DT ><A -HREF="reference.html#CONFIGURING" +HREF="installation.html#CONFIGURING" >Configuring DejaGnu</A ></DT ><DT ><A -HREF="reference.html#INSTALLING" +HREF="installation.html#INSTALLING" >Installing DejaGnu</A ></DT ></DL diff --git a/doc/overview/builtins.html b/doc/overview/builtins.html index 8a01039..dce635a 100644 --- a/doc/overview/builtins.html +++ b/doc/overview/builtins.html @@ -4,7 +4,7 @@ >Builtin Procedures</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -12,8 +12,8 @@ REL="UP" TITLE="Reference" HREF="reference.html"><LINK REL="PREVIOUS" -TITLE="Reference" -HREF="reference.html"><LINK +TITLE="Installation" +HREF="installation.html"><LINK REL="NEXT" TITLE="File Map" HREF="filemap.html"></HEAD @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -37,7 +37,7 @@ WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A -HREF="reference.html" +HREF="installation.html" >Prev</A ></TD ><TD @@ -692,20 +692,14 @@ CLASS="PRODUCTNAME" ><P >Once you use <TT CLASS="FUNCTION" -><B ->setup_xfail</B -></TT +>setup_xfail</TT >, the <TT CLASS="FUNCTION" -><B ->fail</B -></TT +>fail</TT > and <TT CLASS="FUNCTION" -><B ->pass</B -></TT +>pass</TT > procedures produce the messages <I CLASS="EMPHASIS" @@ -739,22 +733,16 @@ ALIGN="LEFT" >Warning you must clear the expected failure after using setup_xfail in a test case. Any call to <TT CLASS="FUNCTION" -><B >pass - </B -></TT + </TT >or <TT CLASS="FUNCTION" -><B ->fail</B -></TT +>fail</TT >l clears the expected failure implicitly; if the test has some other outcome, e.g. an error, you can call <TT CLASS="FUNCTION" -><B ->clear_xfail</B -></TT +>clear_xfail</TT > to clear the expected failure explicitly. Otherwise, the expected-failure declaration applies to whatever test runs next, leading to surprising @@ -895,9 +883,7 @@ NAME="PASS" ><P >Declares a test to have passed. <TT CLASS="FUNCTION" -><B ->pass</B -></TT +>pass</TT > writes in the log files a message beginning with <I @@ -958,9 +944,7 @@ NAME="FAIL" ><P >Declares a test to have failed. <TT CLASS="FUNCTION" -><B ->fail</B -></TT +>fail</TT > writes in the log files a message beginning with <I @@ -1022,9 +1006,7 @@ NAME="XPASS" >Declares a test to have unexpectably passed, when it was expected to be a failure. <TT CLASS="FUNCTION" -><B ->xpass</B -></TT +>xpass</TT > writes in the log files a message beginning with <I @@ -1086,9 +1068,7 @@ NAME="XFAIL" >Declares a test to have expectably failed. <TT CLASS="FUNCTION" -><B ->xfail</B -></TT +>xfail</TT > writes in the log files a message beginning with <I @@ -1157,9 +1137,7 @@ CLASS="EMPHASIS" > disables it: calls to <TT CLASS="FUNCTION" -><B ->warning</B -></TT +>warning</TT > will not turn a <I CLASS="EMPHASIS" @@ -1221,9 +1199,7 @@ CLASS="SYMBOL" >. The default value is 3. This value controls how many <TT CLASS="FUNCTION" -><B ->warning</B -></TT +>warning</TT > procedures can be called before becoming <I CLASS="EMPHASIS" @@ -1258,9 +1234,7 @@ NAME="WARNING" >Declares detection of a minor error in the test case itself. <TT CLASS="FUNCTION" -><B ->warning</B -></TT +>warning</TT > writes in the log files a message beginning with <I CLASS="EMPHASIS" @@ -1273,15 +1247,11 @@ CLASS="PARAMETER" ></TT >. Use <TT CLASS="FUNCTION" -><B ->warning</B -></TT +>warning</TT > rather than <TT CLASS="FUNCTION" -><B ->perror</B -></TT +>perror</TT > for cases (such as communication failure to be followed by a retry) where the test case can recover from the error. If the optional <TT @@ -1300,14 +1270,10 @@ CLASS="SYMBOL" calls to warning in a single test case also changes the effect of the next <TT CLASS="FUNCTION" -><B ->pass</B -></TT +>pass</TT > or <TT CLASS="FUNCTION" -><B ->fail</B -></TT +>fail</TT > command: the test outcome becomes <I CLASS="EMPHASIS" @@ -1379,9 +1345,7 @@ CLASS="PARAMETER" is only used to fake out the counter when using the <TT CLASS="FUNCTION" -><B ->xfail</B -></TT +>xfail</TT > procedure to control when it flips the output over to <I CLASS="EMPHASIS" @@ -1403,9 +1367,7 @@ NAME="PERROR" >Declares a severe error in the testing framework itself. <TT CLASS="FUNCTION" -><B ->perror</B -></TT +>perror</TT > writes in the log files a message beginning with <I CLASS="EMPHASIS" @@ -1421,14 +1383,10 @@ CLASS="PARAMETER" >As a side effect, perror also changes the effect of the next <TT CLASS="FUNCTION" -><B ->pass</B -></TT +>pass</TT > or <TT CLASS="FUNCTION" -><B ->fail</B -></TT +>fail</TT > command: the test outcome becomes <I CLASS="EMPHASIS" @@ -1500,9 +1458,7 @@ CLASS="PARAMETER" is only used to fake out the counter when using the <TT CLASS="FUNCTION" -><B ->xfail</B -></TT +>xfail</TT > procedure to control when it flips the output over to <I CLASS="EMPHASIS" @@ -1524,9 +1480,7 @@ NAME="NOTE" >Appends an informational message to the log file. <TT CLASS="FUNCTION" -><B ->note</B -></TT +>note</TT > writes in the log files a message beginning with <I CLASS="EMPHASIS" @@ -1539,22 +1493,16 @@ CLASS="PARAMETER" ></TT >. Use <TT CLASS="FUNCTION" -><B ->note</B -></TT +>note</TT > sparingly. The <TT CLASS="FUNCTION" -><B ->verbose</B -></TT +>verbose</TT > should be used for most such messages, but in cases where a message is needed in the log file regardless of the verbosity level use <TT CLASS="FUNCTION" -><B ->note</B -></TT +>note</TT >.</P ><DIV CLASS="FUNCSYNOPSIS" @@ -1599,9 +1547,7 @@ NAME="UNTESTED" ><P >Declares a test was not run. <TT CLASS="FUNCTION" -><B ->untested</B -></TT +>untested</TT > writes in the log file a message beginning with <I CLASS="EMPHASIS" @@ -1658,9 +1604,7 @@ NAME="UNRESOLVED" >Declares a test to have an unresolved outcome. <TT CLASS="FUNCTION" -><B ->unresolved</B -></TT +>unresolved</TT > writes in the log file a message beginning with <I CLASS="EMPHASIS" @@ -1717,9 +1661,7 @@ NAME="UNSUPPORTED" >Declares that a test case depends on some facility that does not exist in the testing environment. <TT CLASS="FUNCTION" -><B ->unsupported</B -></TT +>unsupported</TT > writes in the log file a message beginning with <I @@ -2806,9 +2748,7 @@ CLASS="PARAMETER" >This is the value returned by a call to <TT CLASS="FUNCTION" -><B ->remote_open</B -></TT +>remote_open</TT >. This closes the connection to the target so resources can be used by others. This parameter can be left off if the @@ -7987,76 +7927,54 @@ NAME="TOOLSTART" >Starts a particular tool. For an interactive tool, <TT CLASS="FUNCTION" -><B ->${tool}_start</B -></TT +>${tool}_start</TT > starts and initializes the tool, leaving the tool up and running for the test cases; an example is <TT CLASS="FUNCTION" -><B ->gdb_start</B -></TT +>gdb_start</TT >, the start function for GDB. For a batch oriented tool, <TT CLASS="FUNCTION" -><B ->${tool}_start</B -></TT +>${tool}_start</TT > is optional; the recommended convention is to let <TT CLASS="FUNCTION" -><B ->${tool}_start</B -></TT +>${tool}_start</TT > run the tool, leaving the output in a variable called <TT CLASS="FUNCTION" -><B ->comp_output</B -></TT +>comp_output</TT >. Test scripts can then analyze <TT CLASS="FUNCTION" -><B ->$comp_output</B -></TT +>$comp_output</TT > to determine the test results. An example of this second kind of start function is <TT CLASS="FUNCTION" -><B ->gcc_start</B -></TT +>gcc_start</TT >, the start function for GCC.</P ><P >DejaGnu itself does not call <TT CLASS="FUNCTION" -><B ->${tool}_start</B -></TT +>${tool}_start</TT >. The initialization module <TT CLASS="FUNCTION" -><B ->${tool}_init.exp</B -></TT +>${tool}_init.exp</TT > must call <TT CLASS="FUNCTION" -><B ->${tool}_start</B -></TT +>${tool}_start</TT > for interactive tools; for batch-oriented tools, each individual test script calls <TT CLASS="FUNCTION" -><B ->${tool}_start</B -></TT +>${tool}_start</TT > (or makes other arrangements to run the tool).</P ><DIV @@ -8089,30 +8007,22 @@ NAME="TOOLLOAD" this conditions the tool for a particular test case; for example, <TT CLASS="FUNCTION" -><B ->gdb_load</B -></TT +>gdb_load</TT > loads a new executable file into the debugger. For batch oriented tools, <TT CLASS="FUNCTION" -><B ->${tool}_load</B -></TT +>${tool}_load</TT > may do nothing---though, for example, the GCC support uses <TT CLASS="FUNCTION" -><B ->gcc_load</B -></TT +>gcc_load</TT > to load and run a binary on the target environment. Conventionally, <TT CLASS="FUNCTION" -><B ->${tool}_load</B -></TT +>${tool}_load</TT > leaves the output of any program it runs in a variable called <SPAN @@ -8121,18 +8031,14 @@ CLASS="SYMBOL" >. Writing <TT CLASS="FUNCTION" -><B ->${tool}_load</B -></TT +>${tool}_load</TT > can be the most complex part of extending DejaGnu to a new tool or a new target, if it requires much communication coding or file downloading. Test scripts call <TT CLASS="FUNCTION" -><B ->${tool}_load</B -></TT +>${tool}_load</TT >.</P ><DIV CLASS="FUNCSYNOPSIS" @@ -8164,9 +8070,7 @@ NAME="TOOLEXIT" interactive tools, this usually ends the interactive session. You can also use <TT CLASS="FUNCTION" -><B ->${tool}_exit</B -></TT +>${tool}_exit</TT > to remove any temporary files left over from the tests. <B @@ -8175,9 +8079,7 @@ CLASS="COMMAND" > calls <TT CLASS="FUNCTION" -><B ->${tool}_exit</B -></TT +>${tool}_exit</TT >.</P ><DIV CLASS="FUNCSYNOPSIS" @@ -8303,9 +8205,7 @@ CLASS="PARAMETER" >, <TT CLASS="FUNCTION" -><B ->Getdirs</B -></TT +>Getdirs</TT > assumes a default pattern of <I CLASS="EMPHASIS" @@ -10676,7 +10576,7 @@ WIDTH="33%" ALIGN="left" VALIGN="top" ><A -HREF="reference.html" +HREF="installation.html" >Prev</A ></TD ><TD @@ -10701,7 +10601,7 @@ HREF="filemap.html" WIDTH="33%" ALIGN="left" VALIGN="top" ->Reference</TD +>Installation</TD ><TD WIDTH="34%" ALIGN="center" diff --git a/doc/overview/configfile.html b/doc/overview/configfile.html index da718e5..9d75311 100644 --- a/doc/overview/configfile.html +++ b/doc/overview/configfile.html @@ -4,7 +4,7 @@ >Config File Values</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -377,6 +377,20 @@ VALIGN="TOP" >The canonical configuration string for the build host.</TD ></TR +><TR +><TD +ALIGN="LEFT" +VALIGN="TOP" +>--mail</TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +>address</TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +>Email the output log to the specified address.</TD +></TR ></TABLE ></DIV > diff --git a/doc/overview/customizing.html b/doc/overview/customizing.html index e42ce19..2ae04c4 100644 --- a/doc/overview/customizing.html +++ b/doc/overview/customizing.html @@ -4,7 +4,7 @@ >Customizing DejaGnu</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -26,7 +26,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/debugging.html b/doc/overview/debugging.html index 9dc71f0..2c1f33b 100644 --- a/doc/overview/debugging.html +++ b/doc/overview/debugging.html @@ -4,7 +4,7 @@ >Debugging A Test Case</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/designgoals.html b/doc/overview/designgoals.html index d2d88a4..eea7d1a 100644 --- a/doc/overview/designgoals.html +++ b/doc/overview/designgoals.html @@ -4,7 +4,7 @@ >Design Goals</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -68,39 +68,40 @@ NAME="DESIGNGOALS" ></H1 ><P >DejaGnu grew out of the internal needs of Cygnus Solutions. (then - Cygnus Support). Cygnus maintains and enhances a variety of free programs - in many different environments, and we needed a testing tool that:</P + Cygnus Support). Cygnus maintained and enhanced a variety of free + programs in many different environments, and we needed a testing + tool that:</P ><P ></P ><UL ><LI STYLE="list-style-type: disc" ><P ->is useful to developers while fixing +>was useful to developers while fixing bugs.</P ></LI ><LI STYLE="list-style-type: disc" ><P ->automates running many tests during a software +>automated running many tests during a software release process.</P ></LI ><LI STYLE="list-style-type: disc" ><P ->is portable among a variety of host +>was portable among a variety of host computers.</P ></LI ><LI STYLE="list-style-type: disc" ><P ->supports cross-development +>supported cross-development testing.</P ></LI ><LI STYLE="list-style-type: disc" ><P ->permits testing interactive programs, like +>permited testing interactive programs, like <B CLASS="COMMAND" >GDB</B @@ -109,7 +110,7 @@ CLASS="COMMAND" ><LI STYLE="list-style-type: disc" ><P ->permits testing batch oriented programs, like +>permited testing batch oriented programs, like <B CLASS="COMMAND" >GCC</B diff --git a/doc/overview/extending.html b/doc/overview/extending.html index 4cce3b7..904f6af 100644 --- a/doc/overview/extending.html +++ b/doc/overview/extending.html @@ -4,7 +4,7 @@ >Extending DejaGnu</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -26,7 +26,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/filemap.html b/doc/overview/filemap.html index bb894c9..6ea4a31 100644 --- a/doc/overview/filemap.html +++ b/doc/overview/filemap.html @@ -4,7 +4,7 @@ >File Map</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -26,7 +26,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/global.html b/doc/overview/global.html index cc102f3..e3a988c 100644 --- a/doc/overview/global.html +++ b/doc/overview/global.html @@ -4,7 +4,7 @@ >Global Config File</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/hints.html b/doc/overview/hints.html index aaf59ee..cac3d76 100644 --- a/doc/overview/hints.html +++ b/doc/overview/hints.html @@ -4,7 +4,7 @@ >Hints On Writing A Test Case</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/installation.html b/doc/overview/installation.html new file mode 100644 index 0000000..0720d39 --- /dev/null +++ b/doc/overview/installation.html @@ -0,0 +1,347 @@ +<HTML +><HEAD +><TITLE +>Installation</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK +REL="HOME" +TITLE="DejaGnu" +HREF="book1.html"><LINK +REL="UP" +TITLE="Reference" +HREF="reference.html"><LINK +REL="PREVIOUS" +TITLE="Reference" +HREF="reference.html"><LINK +REL="NEXT" +TITLE="Builtin Procedures" +HREF="builtins.html"></HEAD +><BODY +><DIV +CLASS="NAVHEADER" +><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>DejaGnu: The GNU Testing Framework</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="reference.html" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +>Chapter 5. Reference</TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="builtins.html" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="SECT1" +><H1 +CLASS="SECT1" +><A +NAME="INSTALLATION" +>Installation</A +></H1 +><P +>Once you have the DejaGnu source unpacked and available, you must + first configure the software to specify where it is to run (and the + associated defaults); then you can proceed to installing it.</P +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="CONFIGURING" +>Configuring DejaGnu</A +></H2 +><P +>It is usually best to configure in a directory separate from the + source tree, specifying where to find the source with the optional + <I +CLASS="EMPHASIS" +>--srcdir</I +> option to + <I +CLASS="EMPHASIS" +>configure</I +>. DejaGnu uses the GNU + <I +CLASS="EMPHASIS" +>autoconf</I +> to configure itself. For more info on using + autoconf, read the GNU autoconf manual. To configure, execute the + <TT +CLASS="FILENAME" +>configure</TT +> program, no other options are + required. For an example, to configure in a seperate tree for objects, + execute the configure script from the source tree like this:</P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><PRE +CLASS="SCREEN" +> ../dejagnu-1.4/configure + </PRE +></TD +></TR +></TABLE +><P +>DejaGnu doesn't care at config time if it's for testing a native + system or a cross system. That is determined at runtime by using the + config files.</P +><P +>You may also want to use the <B +CLASS="COMMAND" +>configure</B +> option + <I +CLASS="EMPHASIS" +>--prefix</I +> to specify where you want DejaGnu and its + supporting code installed. By default, installation is in subdirectories + of <TT +CLASS="FILENAME" +>/usr/local</TT +>, but you can select any alternate + directory <SPAN +CLASS="SYMBOL" +>altdir</SPAN +> by including + <TT +CLASS="OPTION" +>--prefix</TT +>{altdir}} on the + <B +CLASS="COMMAND" +>configure</B +> command line. (This value is captured in + the Makefile variables <I +CLASS="EMPHASIS" +>prefix</I +> and + <I +CLASS="EMPHASIS" +>exec</I +>prefix}.)</P +><P +>Save for a small number of example tests, the DejaGnu distribution + itself does not include any test suites; these are available + separately. Test suites for the GNU development tools are included in + those releases. After configuring the top-level DejaGnu directory, unpack + and configure the test directories for the tools you want to test; then, + in each test directory, run <I +CLASS="EMPHASIS" +>make check</I +> to build + auxiliary programs required by some of the tests, and run the test + suites.</P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="INSTALLING" +>Installing DejaGnu</A +></H2 +><P +>To install DejaGnu in your filesystem (either in + <TT +CLASS="FILENAME" +>/usr/local</TT +>, or as specified by your + <I +CLASS="EMPHASIS" +>--prefix</I +> option to <I +CLASS="EMPHASIS" +>configure</I +>), + execute.</P +><TABLE +BORDER="0" +BGCOLOR="#E0E0E0" +WIDTH="100%" +><TR +><TD +><PRE +CLASS="SCREEN" +> eg$ make install + </PRE +></TD +></TR +></TABLE +><P +><I +CLASS="EMPHASIS" +>make install</I +>does thes things for + DejaGnu:</P +><P +></P +><UL +><LI +STYLE="list-style-type: disc" +><P +>Look in the path specified for executables + <SPAN +CLASS="SYMBOL" +>$exec_prefix</SPAN +>) for directories called + <TT +CLASS="FILENAME" +>lib</TT +> and <TT +CLASS="FILENAME" +>bin</TT +>. If these + directories do not exist, <I +CLASS="EMPHASIS" +>make install</I +> creates + them.</P +></LI +><LI +STYLE="list-style-type: disc" +><P +>Create another directory in the + <TT +CLASS="FILENAME" +>share</TT +> directory, called + <TT +CLASS="FILENAME" +>dejagnu</TT +>, and copy all the library files into + it.</P +></LI +><LI +STYLE="list-style-type: disc" +><P +>Create a directory in the + <TT +CLASS="FILENAME" +>dejagnu/share</TT +> directory, called + <TT +CLASS="FILENAME" +>config</TT +>, and copy all the configuration files into + it.</P +></LI +><LI +STYLE="list-style-type: disc" +><P +>Copy the <I +CLASS="EMPHASIS" +>runtest</I +> shell script into + <TT +CLASS="FILENAME" +>$exec_prefix/bin</TT +>.</P +></LI +><LI +STYLE="list-style-type: disc" +><P +>Copy <TT +CLASS="FILENAME" +>runtest.exp</TT +> into + <TT +CLASS="FILENAME" +>$exec_prefix/lib/dejagnu</TT +>. This is the main Tcl + code implementing DejaGnu.</P +></LI +></UL +></DIV +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="reference.html" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="book1.html" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="builtins.html" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Reference</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="reference.html" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>Builtin Procedures</TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file diff --git a/doc/overview/new.html b/doc/overview/new.html index edf4c6d..87e17b5 100644 --- a/doc/overview/new.html +++ b/doc/overview/new.html @@ -4,7 +4,7 @@ >What's New In This Release</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -144,7 +144,7 @@ NAME="CYGWIN" ><P >To use DejaGnu on NT, you need to first install the <A -HREF="http://sources.redhat.com" +HREF="http://sources.redhat.com/cygwin" TARGET="_top" >Cygwin</A > @@ -153,7 +153,7 @@ TARGET="_top" that adds POSIX system calls to NT. Among them is pseudo tty support for NT that emulates the POSIX pty standard. The latest Cygwin is always available from <A -HREF="http://sources.redhat.com" +HREF="http://sources.redhat.com/cygwin" TARGET="_top" >this location</A >. This @@ -225,4 +225,4 @@ VALIGN="top" ></DIV ></BODY ></HTML -> +>
\ No newline at end of file diff --git a/doc/overview/outputfiles.html b/doc/overview/outputfiles.html index 97931b3..ff8e8bf 100644 --- a/doc/overview/outputfiles.html +++ b/doc/overview/outputfiles.html @@ -4,7 +4,7 @@ >The files DejaGnu produces.</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/overview.html b/doc/overview/overview.html index 6be010f..1972cb9 100644 --- a/doc/overview/overview.html +++ b/doc/overview/overview.html @@ -4,7 +4,7 @@ >Overview</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -26,7 +26,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/posix.html b/doc/overview/posix.html index 4a35a55..3f96d05 100644 --- a/doc/overview/posix.html +++ b/doc/overview/posix.html @@ -4,7 +4,7 @@ >A POSIX conforming test framework</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/preface.html b/doc/overview/preface.html index acceb36..7ffa9cc 100644 --- a/doc/overview/preface.html +++ b/doc/overview/preface.html @@ -4,7 +4,7 @@ >Abstract</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -26,7 +26,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/reference.html b/doc/overview/reference.html index 9c2f57b..9e4b9ca 100644 --- a/doc/overview/reference.html +++ b/doc/overview/reference.html @@ -4,7 +4,7 @@ >Reference</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -12,8 +12,8 @@ REL="PREVIOUS" TITLE="Special variables used by test cases." HREF="tvariables.html"><LINK REL="NEXT" -TITLE="Builtin Procedures" -HREF="builtins.html"></HEAD +TITLE="Installation" +HREF="installation.html"></HEAD ><BODY ><DIV CLASS="NAVHEADER" @@ -26,7 +26,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -47,7 +47,7 @@ WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A -HREF="builtins.html" +HREF="installation.html" >Next</A ></TD ></TR @@ -71,7 +71,12 @@ CLASS="TOC" ></DT ><DT ><A -HREF="reference.html#INSTALLATION" +HREF="reference.html#OBTAINING" +>Obtaining DejaGnu</A +></DT +><DT +><A +HREF="installation.html" >Installation</A ></DT ><DT @@ -91,227 +96,22 @@ CLASS="SECT1" ><H1 CLASS="SECT1" ><A -NAME="INSTALLATION" ->Installation</A +NAME="OBTAINING" +>Obtaining DejaGnu</A ></H1 ><P ->Once you have the DejaGnu source unpacked and available, you must - first configure the software to specify where it is to run (and the - associated defaults); then you can proceed to installing it.</P -><DIV -CLASS="SECT2" -><H2 -CLASS="SECT2" -><A -NAME="CONFIGURING" ->Configuring DejaGnu</A -></H2 -><P ->It is usually best to configure in a directory separate from the - source tree, specifying where to find the source with the optional - <I -CLASS="EMPHASIS" ->--srcdir</I -> option to - <I -CLASS="EMPHASIS" ->configure</I ->. DejaGnu uses the GNU - <I -CLASS="EMPHASIS" ->autoconf</I -> to configure itself. For more info on using - autoconf, read the GNU autoconf manual. To configure, execute the - <TT -CLASS="FILENAME" ->configure</TT -> program, no other options are - required. For an example, to configure in a seperate tree for objects, - execute the configure script from the source tree like this:</P -><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><PRE -CLASS="SCREEN" -> ../dejagnu-1.4/configure - </PRE -></TD -></TR -></TABLE -><P ->DejaGnu doesn't care at config time if it's for testing a native - system or a cross system. That is determined at runtime by using the - config files.</P -><P ->You may also want to use the <B -CLASS="COMMAND" ->configure</B -> option - <I -CLASS="EMPHASIS" ->--prefix</I -> to specify where you want DejaGnu and its - supporting code installed. By default, installation is in subdirectories - of <TT -CLASS="FILENAME" ->/usr/local</TT ->, but you can select any alternate - directory <SPAN -CLASS="SYMBOL" ->altdir</SPAN -> by including - <TT -CLASS="OPTION" ->--prefix</TT ->{altdir}} on the - <B -CLASS="COMMAND" ->configure</B -> command line. (This value is captured in - the Makefile variables <I -CLASS="EMPHASIS" ->prefix</I -> and - <I -CLASS="EMPHASIS" ->exec</I ->prefix}.)</P -><P ->Save for a small number of example tests, the DejaGnu distribution - itself does not include any test suites; these are available - separately. Test suites for the GNU development tools are included in - those releases. After configuring the top-level DejaGnu directory, unpack - and configure the test directories for the tools you want to test; then, - in each test directory, run <I -CLASS="EMPHASIS" ->make check</I -> to build - auxiliary programs required by some of the tests, and run the test - suites.</P -></DIV -><DIV -CLASS="SECT2" -><H2 -CLASS="SECT2" -><A -NAME="INSTALLING" ->Installing DejaGnu</A -></H2 -><P ->To install DejaGnu in your filesystem (either in - <TT -CLASS="FILENAME" ->/usr/local</TT ->, or as specified by your - <I -CLASS="EMPHASIS" ->--prefix</I -> option to <I -CLASS="EMPHASIS" ->configure</I ->), - execute.</P -><TABLE -BORDER="0" -BGCOLOR="#E0E0E0" -WIDTH="100%" -><TR -><TD -><PRE -CLASS="SCREEN" -> eg$ make install - </PRE -></TD -></TR -></TABLE -><P -><I -CLASS="EMPHASIS" ->make install</I ->does thes things for - DejaGnu:</P -><P +>You can obtain DejaGnu from the DejaGnu web site at the + <A +HREF="http://www.gnu.org" +TARGET="_top" +>Free Software Foundation</A +>, + which is at <A +HREF="http://www.gnu.org/software/dejagnu/" +TARGET="_top" +>www.gnu.org/software/dejagnu/ + </A ></P -><UL -><LI -STYLE="list-style-type: disc" -><P ->Look in the path specified for executables - <SPAN -CLASS="SYMBOL" ->$exec_prefix</SPAN ->) for directories called - <TT -CLASS="FILENAME" ->lib</TT -> and <TT -CLASS="FILENAME" ->bin</TT ->. If these - directories do not exist, <I -CLASS="EMPHASIS" ->make install</I -> creates - them.</P -></LI -><LI -STYLE="list-style-type: disc" -><P ->Create another directory in the - <TT -CLASS="FILENAME" ->share</TT -> directory, called - <TT -CLASS="FILENAME" ->dejagnu</TT ->, and copy all the library files into - it.</P -></LI -><LI -STYLE="list-style-type: disc" -><P ->Create a directory in the - <TT -CLASS="FILENAME" ->dejagnu/share</TT -> directory, called - <TT -CLASS="FILENAME" ->config</TT ->, and copy all the configuration files into - it.</P -></LI -><LI -STYLE="list-style-type: disc" -><P ->Copy the <I -CLASS="EMPHASIS" ->runtest</I -> shell script into - <TT -CLASS="FILENAME" ->$exec_prefix/bin</TT ->.</P -></LI -><LI -STYLE="list-style-type: disc" -><P ->Copy <TT -CLASS="FILENAME" ->runtest.exp</TT -> into - <TT -CLASS="FILENAME" ->$exec_prefix/lib/dejagnu</TT ->. This is the main Tcl - code implementing DejaGnu.</P -></LI -></UL -></DIV ></DIV ></DIV ><DIV @@ -345,7 +145,7 @@ WIDTH="33%" ALIGN="right" VALIGN="top" ><A -HREF="builtins.html" +HREF="installation.html" >Next</A ></TD ></TR @@ -364,7 +164,7 @@ VALIGN="top" WIDTH="33%" ALIGN="right" VALIGN="top" ->Builtin Procedures</TD +>Installation</TD ></TR ></TABLE ></DIV diff --git a/doc/overview/releng.html b/doc/overview/releng.html index 58f9cd4..d1e2edd 100644 --- a/doc/overview/releng.html +++ b/doc/overview/releng.html @@ -4,7 +4,7 @@ >Remote Host Testing</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/runningtests.html b/doc/overview/runningtests.html index 54e3291..a78cf8c 100644 --- a/doc/overview/runningtests.html +++ b/doc/overview/runningtests.html @@ -4,7 +4,7 @@ >Running Tests</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -26,7 +26,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/overview/runtest.html b/doc/overview/runtest.html index 8188e4b..73fbb57 100644 --- a/doc/overview/runtest.html +++ b/doc/overview/runtest.html @@ -4,7 +4,7 @@ >Runtest</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -827,7 +827,7 @@ CLASS="OPTION" ><P >Start the internal Tcl debugger. The Tcl debugger supports breakpoints, single stepping, and other common debugging - activities. See the document "Debugger for Tcl Applications} by Don + activities. See the document "Debugger for Tcl Applications" by Don Libes. (Distributed in PostScript form with <I CLASS="EMPHASIS" diff --git a/doc/overview/tvariables.html b/doc/overview/tvariables.html index 0bcb733..ee28884 100644 --- a/doc/overview/tvariables.html +++ b/doc/overview/tvariables.html @@ -4,7 +4,7 @@ >Special variables used by test cases.</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD @@ -122,9 +122,7 @@ CLASS="EMPHASIS" >This is the output from a <TT CLASS="FUNCTION" -><B ->${tool}_load</B -></TT +>${tool}_load</TT > command. This only applies to tools like GCC and GAS which produce an object file that must in turn be executed to complete a test.</P @@ -136,9 +134,7 @@ CLASS="FUNCTION" >This is the output from a <TT CLASS="FUNCTION" -><B ->${tool}_start</B -></TT +>${tool}_start</TT > command. This is conventionally used for batch oriented programs, like GCC and GAS, that may produce interesting output (warnings, errors) without further diff --git a/doc/overview/writing.html b/doc/overview/writing.html index b8b8e0f..17e09ed 100644 --- a/doc/overview/writing.html +++ b/doc/overview/writing.html @@ -4,7 +4,7 @@ >Writing A Test Case</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.33"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.44"><LINK REL="HOME" TITLE="DejaGnu" HREF="book1.html"><LINK @@ -29,7 +29,7 @@ CELLSPACING="0" ><TH COLSPAN="3" ALIGN="center" ->DejaGnu</TH +>DejaGnu: The GNU Testing Framework</TH ></TR ><TR ><TD diff --git a/doc/ref.sgml b/doc/ref.sgml index 1256e00..6e0c9f5 100644 --- a/doc/ref.sgml +++ b/doc/ref.sgml @@ -1,6 +1,17 @@ <chapter id=reference> <title>Reference</title> + <sect1 id=obtaining xreflabel="Obtaining DejaGnu"> + <title>Obtaining DejaGnu</title> + + <para>You can obtain DejaGnu from the DejaGnu web site at the + <ulink URL="http://www.gnu.org">Free Software Foundation</ulink>, + which is at <ulink + URL="http://www.gnu.org/software/dejagnu/">www.gnu.org/software/dejagnu/ + </ulink></para> + + </sect1> + <sect1 id=installation xreflabel="Installation"> <title>Installation</title> @@ -22,7 +33,7 @@ execute the configure script from the source tree like this:</para> <screen> - ../dejagnu-1.4/configure + ../dejagnu-&version/configure </screen> <para>DejaGnu doesn't care at config time if it's for testing a native @@ -3465,7 +3476,7 @@ is a list of two elements. The first is the pathname of the testsuite expect script running. The second is a copy of what was on the right side of the <emphasis>=</emphasis> if - <programlisting>foo.exp="..."</programlisting>" was specified, or + <programlisting>foo.exp="..."</programlisting>" was specified, or an empty string if no such argument is present. This is used by tools like compilers where each testcase is a file.</para> @@ -4246,3 +4257,21 @@ </sect1> </chapter> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-namecase-general:t +sgml-general-insert-case:lower +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:nil +sgml-parent-document:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> diff --git a/doc/user.sgml b/doc/user.sgml index 143e1ac..7c38d4d 100644 --- a/doc/user.sgml +++ b/doc/user.sgml @@ -397,7 +397,7 @@ <term><option>--D[0-1]</option></term> <listitem><para>Start the internal Tcl debugger. The Tcl debugger supports breakpoints, single stepping, and other common debugging - activities. See the document "Debugger for Tcl Applications} by Don + activities. See the document "Debugger for Tcl Applications" by Don Libes. (Distributed in PostScript form with <emphasis>expect</emphasis> as the file <filename>expect/tcl-debug.ps.</filename>. If you specify @@ -1308,6 +1308,12 @@ host.</entry> </row> + <row> + <entry>--mail</entry> + <entry>address</entry> + <entry>Email the output log to the specified address.</entry> + </row> + </tbody> </tgroup> </table> @@ -2264,7 +2270,7 @@ usually too dependent on terminal settings.</para> <para>Always escape punctuation, such as <emphasis>(</emphasis> - or <emphasis>"</emphasis>, in your patterns; for example, write + or <emphasis>"</emphasis>, in your patterns; for example, write <emphasis>\(</emphasis>. If you forget to escape punctuation, you will usually see an error message like <programlisting>extra characters after close-quote.</programlisting></para> @@ -2356,3 +2362,20 @@ </chapter> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-namecase-general:t +sgml-general-insert-case:lower +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:nil +sgml-parent-document:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +-->
\ No newline at end of file |