aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBen Elliston <bje@gnu.org>2005-12-31 02:43:37 +0000
committerBen Elliston <bje@gnu.org>2005-12-31 02:43:37 +0000
commit20b1ef7e5d91fac21aa7c1cd8735693652b96c83 (patch)
tree56963e6cf3322d29e6ed693ca708a3f16d8fac85 /doc
parent4a1dd5bcd9048a5e88f3e2e6664393d56280a645 (diff)
downloaddejagnu-20b1ef7e5d91fac21aa7c1cd8735693652b96c83.zip
dejagnu-20b1ef7e5d91fac21aa7c1cd8735693652b96c83.tar.gz
dejagnu-20b1ef7e5d91fac21aa7c1cd8735693652b96c83.tar.bz2
* doc/ref.xml (Utility Procedures): Note that the following
procedures are deprecated: absolute, psource, prune, slay. * NEWS: Likewise. * doc/dejagnu.texi: Regenerate.
Diffstat (limited to 'doc')
-rw-r--r--doc/dejagnu.texi85
-rw-r--r--doc/ref.xml98
2 files changed, 33 insertions, 150 deletions
diff --git a/doc/dejagnu.texi b/doc/dejagnu.texi
index c282b34..3f64e52 100644
--- a/doc/dejagnu.texi
+++ b/doc/dejagnu.texi
@@ -1,5 +1,5 @@
\input texinfo
-@setfilename dejagnu.info
+@setfilename untitled.info
@documentencoding us-ascii
@direntry
* DejaGnu: . ???
@@ -6353,85 +6353,34 @@ regexp matches.
@node prune procedure, slay procedure, grep procedure, Utility Procedures
@subsubsection Prune Procedure
-Remove elements of the Tcl list @i{list}.
-Elements are fields delimited by spaces. The result is a copy of
-list, without any elements that match @i{pattern}.
-You can use the common shell wildcard characters to specify the
-pattern.
-
-@quotation
-
-@t{@b{prune}(@i{list}
-@i{pattern});}
-@end quotation
-
-@table @asis
-
-@item @code{list}
-A Tcl list containing the original data. Commonly
-this is the output of a batch executed command, like running a
-compiler.
-
-@item @code{pattern}
-The csh shell "glob" style pattern to search
-for.
-@end table
+This procedure is deprecated and will be removed in
+the next release of DejaGnu. If a testsuite uses this
+procedure, a copy of the procedure should be made and placed
+in the lib directory of the testsuite.
@node slay procedure, absolute procedure, prune procedure, Utility Procedures
@subsubsection Slay Procedure
-This look in the process table for @i{name}
-and send it a unix SIGINT, killing the process. This will only work
-under Windows if you have Cygwin or another Unix subsystem for Windows
-installed.
-
-@quotation
-
-@t{@b{slay}(@i{name});}
-@end quotation
-
-@table @asis
-
-@item @code{name}
-The name of the program to kill.
-@end table
+This procedure is deprecated and will be removed in
+the next release of DejaGnu. If a testsuite uses this
+procedure, a copy of the procedure should be made and placed
+in the lib directory of the testsuite.
@node absolute procedure, psource procedure, slay procedure, Utility Procedures
@subsubsection Absolute Procedure
-This procedure takes the relative @i{path},
-and converts it to an absolute path.
-
-@quotation
-
-@t{@b{absolute}(@i{path});}
-@end quotation
-
-@table @asis
-
-@item @code{path}
-The path to convert.
-@end table
+This procedure is deprecated and will be removed in
+the next release of DejaGnu. If a testsuite uses this
+procedure, a copy of the procedure should be made and placed
+in the lib directory of the testsuite.
@node psource procedure, runtest_file_p procedure, absolute procedure, Utility Procedures
@subsubsection Psource Procedure
-This sources the file @i{filename}, and traps
-all errors. It also ignores all extraneous output. If there was an
-error it returns a @i{1}, otherwise it returns a
-@i{0}.
-
-@quotation
-
-@t{@b{psource}(@i{file});}
-@end quotation
-
-@table @asis
-
-@item @code{filename}
-The filename to Tcl script to
-source.
-@end table
+This procedure is deprecated and will be removed in
+the next release of DejaGnu. If a testsuite uses this
+procedure, a copy of the procedure should be made and placed
+in the lib directory of the testsuite.
@node runtest_file_p procedure, diff procedure, psource procedure, Utility Procedures
@subsubsection Runtest_file_p Procedure
diff --git a/doc/ref.xml b/doc/ref.xml
index e603d04..fd8239e 100644
--- a/doc/ref.xml
+++ b/doc/ref.xml
@@ -3665,100 +3665,34 @@
<sect4 id="prune" xreflabel="prune procedure">
<title>Prune Procedure</title>
-
- <para>Remove elements of the Tcl list <emphasis>list</emphasis>.
- Elements are fields delimited by spaces. The result is a copy of
- list, without any elements that match <emphasis>pattern</emphasis>.
- You can use the common shell wildcard characters to specify the
- pattern.</para>
-
- <funcsynopsis role="tcl">
- <funcprototype>
- <funcdef><function>prune</function></funcdef>
- <paramdef><parameter>list</parameter>
- <parameter>pattern</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- <variablelist>
- <varlistentry>
- <term><parameter>list</parameter></term>
- <listitem><para>A Tcl list containing the original data. Commonly
- this is the output of a batch executed command, like running a
- compiler.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pattern</parameter></term>
- <listitem><para>The csh shell "glob" style pattern to search
- for.</para></listitem>
- </varlistentry>
- </variablelist>
-
+ <para>This procedure is deprecated and will be removed in
+ the next release of DejaGnu. If a testsuite uses this
+ procedure, a copy of the procedure should be made and placed
+ in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="slay" xreflabel="slay procedure">
<title>Slay Procedure</title>
-
- <para>This look in the process table for <emphasis>name</emphasis>
- and send it a unix SIGINT, killing the process. This will only work
- under Windows if you have Cygwin or another Unix subsystem for Windows
- installed.</para>
-
- <funcsynopsis role="tcl">
- <funcprototype>
- <funcdef><function>slay</function></funcdef>
- <paramdef><parameter>name</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- <variablelist>
- <varlistentry>
- <term><parameter>name</parameter></term>
- <listitem><para>The name of the program to kill.</para></listitem>
- </varlistentry>
- </variablelist>
-
+ <para>This procedure is deprecated and will be removed in
+ the next release of DejaGnu. If a testsuite uses this
+ procedure, a copy of the procedure should be made and placed
+ in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="absolute" xreflabel="absolute procedure">
<title>Absolute Procedure</title>
-
- <para>This procedure takes the relative <emphasis>path</emphasis>,
- and converts it to an absolute path.</para>
-
- <funcsynopsis role="tcl">
- <funcprototype>
- <funcdef><function>absolute</function></funcdef>
- <paramdef><parameter>path</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- <variablelist>
- <varlistentry>
- <term><parameter>path</parameter></term>
- <listitem><para>The path to convert.</para></listitem>
- </varlistentry>
- </variablelist>
+ <para>This procedure is deprecated and will be removed in
+ the next release of DejaGnu. If a testsuite uses this
+ procedure, a copy of the procedure should be made and placed
+ in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="psource" xreflabel="psource procedure">
<title>Psource Procedure</title>
-
- <para>This sources the file <emphasis>filename</emphasis>, and traps
- all errors. It also ignores all extraneous output. If there was an
- error it returns a <emphasis>1</emphasis>, otherwise it returns a
- <emphasis>0</emphasis>.</para>
-
- <funcsynopsis role="tcl">
- <funcprototype>
- <funcdef><function>psource</function></funcdef>
- <paramdef><parameter>file</parameter></paramdef>
- </funcprototype>
- </funcsynopsis>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem><para>The filename to Tcl script to
- source.</para></listitem>
- </varlistentry>
- </variablelist>
+ <para>This procedure is deprecated and will be removed in
+ the next release of DejaGnu. If a testsuite uses this
+ procedure, a copy of the procedure should be made and placed
+ in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="runtestfilep" xreflabel="runtest_file_p procedure">