GNU bug report logs - #44703
Inadequate documentation of dejagnu.exp

Previous Next

Package: dejagnu;

Reported by: Robert Menteer <reetnem <at> mac.com>

Date: Tue, 17 Nov 2020 13:54:02 UTC

Severity: minor

Done: Jacob Bachmeyer <jcb62281 <at> gmail.com>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 44703 in the body.
You can then email your comments to 44703 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-dejagnu <at> gnu.org:
bug#44703; Package dejagnu. (Tue, 17 Nov 2020 13:54:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Robert Menteer <reetnem <at> mac.com>:
New bug report received and forwarded. Copy sent to bug-dejagnu <at> gnu.org. (Tue, 17 Nov 2020 13:54:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Robert Menteer <reetnem <at> mac.com>
To: Robert Menteer via Bug-dejagnu <bug-dejagnu <at> gnu.org>
Subject: Inadequate documentation of dejagnu.exp
Date: Tue, 17 Nov 2020 08:53:08 -0500
[Message part 1 (text/plain, inline)]
Section 5.1 implies each unit test is batch process. Section 5.2 states that dejagnu.exp can be used for testing the batch processes for unit testing. Section 4.6 says to look examine the GNU GCC testsuite for how to write test for batch processes.

The section on using dejagnu.exp states little TCL is needed but the GNU GCC tests have thousands of lines of TCL. It took me many days before I finally did «find / -name dejagnu.exp» and looked to see how to write an xxx.exp file for a unit test.

Please document how to use the procedures in dejagnu.exp and supply a minimal unit test xxx.exp file like the one below.

load_lib dejagnu.exp
host_execute $srcdir/unit-code/t_opts

At a bare minimum tell people to read dejagnu.exp


Thanks,
Bob Menteer

[Message part 2 (text/html, inline)]

Reply sent to jcb62281 <at> gmail.com:
You have taken responsibility. (Wed, 18 Nov 2020 03:58:04 GMT) Full text and rfc822 format available.

Notification sent to Robert Menteer <reetnem <at> mac.com>:
bug acknowledged by developer. (Wed, 18 Nov 2020 03:58:04 GMT) Full text and rfc822 format available.

Message #10 received at 44703-done <at> debbugs.gnu.org (full text, mbox):

From: Jacob Bachmeyer <jcb62281 <at> gmail.com>
To: Robert Menteer <reetnem <at> mac.com>, 
 Robert Menteer via Bug-dejagnu <bug-dejagnu <at> gnu.org>
Cc: 44703-done <at> debbugs.gnu.org
Subject: Re: bug#44703: Inadequate documentation of dejagnu.exp
Date: Tue, 17 Nov 2020 21:57:47 -0600
Robert Menteer via Bug-dejagnu via wrote:
> Section 5.1 implies each unit test is batch process. Section 5.2 
> states that dejagnu.exp can be used for testing the batch processes 
> for unit testing. Section 4.6 says to look examine the GNU GCC 
> testsuite for how to write test for batch processes.

When referring to the manual, please include the titles of the sections; 
the section numbering has recently changed and will continue to change 
as the manual is reorganized.

> The section on using dejagnu.exp states little TCL is needed but the 
> GNU GCC tests have thousands of lines of TCL. It took me many days 
> before I finally did «find / -name dejagnu.exp» and looked to see how 
> to write an xxx.exp file for a unit test.
>
> Please document how to use the procedures in dejagnu.exp and supply a 
> minimal unit test xxx.exp file like the one below.

In current Git master (soon to be a 1.6.3-rc), there is a chapter 6 
"Unit Testing" and additional improvements to the existing unit test 
support in dejagnu.h are a notable item currently planned for 1.6.4.

> load_lib dejagnu.exp
> host_execute $srcdir/unit-code/t_opts

I believe that the current manual adequately explains this, but I will 
add a note to my TODO list for the ongoing larger manual restructuring.

Closing report as already fixed; not in current master.


-- Jacob





Information forwarded to bug-dejagnu <at> gnu.org:
bug#44703; Package dejagnu. (Wed, 18 Nov 2020 03:59:01 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Wed, 16 Dec 2020 12:24:04 GMT) Full text and rfc822 format available.

This bug report was last modified 4 years and 246 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.