GNU bug report logs - #44636
Misleading documentation

Previous Next

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

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

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: Misleading documentation
Date: Sat, 14 Nov 2020 11:14:13 -0500

[Message part 1 (text/plain, inline)]

In section 4.2.2 of the info manual for DejaGnu it suggests to create a subdirectory config then create a tool init file in it. If I copy the unix.exp example to /…/testsuite/config/tool.exp runtool does not appear to read it. Looking around the web I found a mention of placing the init file in /…/testsuite/lib/. This does seem to work as I get the following output:

Using ./lib/FlDist.exp as tool init file.

Another problem with the example init file in that same section is the expect statement:

global ${examplename}

This causes the following error:

ERROR: tcl error sourcing tool init file ./lib/FlDist.exp.
can't read "examplename": no such variable

The problem with the documentation is not that it uses examplename in it’s example but there is nothing explaining how to modify examplename to fit the tool. This is in contrast to naming files which is explained in the manual.

Thanks,
Bob Menteer

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

Message #8 received at submit <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: 44636-done <at> debbugs.gnu.org
Subject: Re: bug#44636: Misleading documentation
Date: Tue, 17 Nov 2020 21:56:55 -0600

Robert Menteer via Bug-dejagnu via wrote:
> In section 4.2.2 of the info manual for DejaGnu it suggests to create 
> a subdirectory config then create a tool init file in it. If I copy 
> the unix.exp example to /…/testsuite/config/tool.exp runtool does not 
> appear to read it.

You are correct that this is wrong; the manual is conflating tool init 
files and target interface files here.

> Looking around the web I found a mention of placing the init file in 
> /…/testsuite/lib/.

This is correct; the manual has been corrected in commit 
9950000f4ec0f6cd2c5afbc8ec5413391c20a535.

Closing as now fixed.


-- Jacob

Previous Next

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