Examples in manuals – how to verify (test) them

I’ve gotten some just comments as feedback for the examples in the Searduino Manuals. Searduino is a software to make it easy to program C/C++ for Arduino, a simulator for source level Arduino API, … and more.

Problem is the following: I’d written some examples to make it easy to get started with Searduino. After some weeks of updates to the code the examples were not correct anymore. What good is it to have examples if they don’t work? But on the other hand, it’s really a pain in the ¤/&% to have to update example code. We need a way to test example code in manuals and to automate the tests!

Copying/pasting code from a manual is not something that is not desired (error prune to say one problem). So how to find some middle ground here? Is there any software for this?

My temporary solution was to write all examples as C files and Makefiles and to write some scripts to

  • convert a C file to texinfo file (c2texi)
  • convert a Makefile file to texinfo file (makefile2texi)

and then include the generated texi files in the manual (written in Texinfo). Will probably do the same for GNU Xnee

There must be  a better way … or?

 

Advertisements

GNU Xnee 3.12 (‘Hannes’) released

We are pleased to announce the availability of GNU Xnee 3.12

GNU Xnee is a suite of programs that can record, replay and distribute
user actions under the X11 environment. Think of it as a robot that can
imitate the job you just did. GNU Xnee can be used to:
Automate tests
Demonstrate programs
Distribute actions
Record and replay ‘macro’
Retype the content of a file

Getting the Software
====================

ftp://ftp.gnu.org/gnu/xnee/xnee-3.12.tar.gz
ftp://ftp.gnu.org/gnu/xnee/xnee-3.12.tar.gz.sig

or one of the mirror sites as found in:

http://www.gnu.org/prep/ftp.html

Checksums
===========

md5sum:
c2a74e8d1f3965c5f3b47aadb40ba5e3  xnee-3.12.tar.gz

cksum:
2575836771 1798047 xnee-3.12.tar.gz

New in this release
===================

* New option: –record-replay, -rr
Record and replay a session (press q to stop recording)

* Fixed bugs:

Savannah
bug #35029, Segmentation fault when using stop…

…. for Hannes

GNU Xnee 3.11 (‘Jansch’) released

We are pleased to announce the availability of GNU Xnee 3.11

GNU Xnee is a suite of programs that can record, replay and distribute
user actions under the X11 environment. Think of it as a robot that can
imitate the job you just did. GNU Xnee can be used to:
    Automate tests
    Demonstrate programs
    Distribute actions
    Record and replay 'macro'
    Retype the content of a file

Getting the Software
====================

   ftp://ftp.gnu.org/gnu/xnee/xnee-3.11.tar.gz
   ftp://ftp.gnu.org/gnu/xnee/xnee-3.11.tar.gz.sig

or one of the mirror sites as found in:

   http://www.gnu.org/prep/ftp.html

Checksums
===========

  md5sum:
     f2c15ebdda44480ac59c0048a2809f09  xnee-3.11.tar.gz

  cksum:
     1228726175 1788094 xnee-3.11.tar.gz

New in this release
===================

   * Fixed bugs:

     Savannah:
       #30137: gnee crashes on Ubuntu 10.04

     Recording in X.org > 1.11 does not work 

     Fedora / Red Hat Bugzilla – Bug 757733

     Mem error when distributing to multiple displays

... and the name 'Jansch'? It's a tribute to Bert Jansch, who died 5 October 2011.
http://en.wikipedia.org/wiki/Bert_Jansch

GNU Xnee 3.10 (‘Heron’) released

We are pleased to announce the availability of GNU Xnee 3.10

GNU Xnee is a suite of programs that can record, replay and distribute
user actions under the X11 environment. Think of it as a robot that can
imitate the job you just did. GNU Xnee can be used to:
    Automate tests
    Demonstrate programs
    Distribute actions
    Record and replay 'macro'
    Retype the content of a file

Getting the Software

  http://ftp.gnu.org/gnu/xnee/xnee-3.10.tar.gz
  http://ftp.gnu.org/gnu/xnee/xnee-3.10.tar.gz.sig

or one of the mirror sites as found in:

   http://www.gnu.org/prep/ftp.html

Checksums


  md5sum:
	193feae64496d8c83ba32ce3994123da  xnee-3.10.tar.gz

  cksum:
	2336257076 1783909 xnee-3.10.tar.gz


New in this release

   The timing algorithm for replay synchronisation has been
   rewritten. This should improve the timing accuracy for application
   such as drawing programs where the time spent in one position is
   affecting the thickness of a dot being painted.

   * Fixed bugs:

     Savannah:
        #33237, Xnee fails to record on RedHat
        #33667, Seg fault (on Ubuntu 11.04)
        #32385: CNEE replay precision
        #32767: Button key to stop recoring
        #32762: no sync option faulty


... and the name 'heron'? 
It's a tribute to the artist: Gil Scott-Heron - http://en.wikipedia.org/wiki/Gil_Scott_Heron - who recently passed away (May 2011)

GNU Xnee 3.09 (‘Moore’) released

We are pleased to announce the availability of GNU Xnee 3.09

GNU Xnee is a suite of programs that can record, replay and distribute  user actions under the X11 environment. Think of it as a robot that can imitate the job you just did. GNU Xnee can be used to:

  • Automate tests
  • Demonstrate programs
  • Distribute actions
  • Record and replay ‘macro’
  • Retype the content of a file

Getting the Software

http://ftp.gnu.org/gnu/xnee/xnee-3.09.tar.gz
http://ftp.gnu.org/gnu/xnee/xnee-3.09.tar.gz.sig

or one of the mirror sites as found in:

http://www.gnu.org/prep/ftp.html

Checksums

md5sum:
c59b875a522dc71be545921c30a0c807  xnee-3.09.tar.gz

cksum:
111533042 1782493 xnee-3.09.tar.gz

New in this release

* Fixed bugs:

Reported on Savannah:
#31231: Replay in demo mode malfunctions
#28238: XI2 extension support
#28431: Separate tests needing a running X server
#32291: Xnee fails checking gtk.h
#28242: Missing makeinfo dep in configure

Reported on xnee-devel mailing list:
cnee loves Xephyr ?
lists.gnu.org/archive/html/xnee-devel/2011-02/msg00000.html

Debian bug report:
# 613237 “3.08 is available which works fine in unstable”

About calling the release “Moore”

Following the tradition to pay tribute to old heroes who have passed away this release is named after Gary Moore. I used to listen to Thin Lizzy and from there I discovered Moore. Somewhere in a box somewhere I have a shaped picture 12″ vinyl of Shapes of things. This song is written by Yardbirds member so I discovered them through Moore ….

http://en.wikipedia.org/wiki/Gary_moore