From 7ce220e42fed5f6aaa9b0be426dbb08554962502 Mon Sep 17 00:00:00 2001
From: Kelvin Lawson <kelvin.a.lawson@gmail.com>
Date: Thu, 21 Jun 2012 22:41:53 +0100
Subject: [PATCH] AVR expect script for test runs: Add description header.

---
 ports/avr/run_test.exp | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/ports/avr/run_test.exp b/ports/avr/run_test.exp
index 7adacad..0bb59db 100755
--- a/ports/avr/run_test.exp
+++ b/ports/avr/run_test.exp
@@ -1,6 +1,14 @@
 #!/usr/bin/env expect
 
-# Start the test (arguments: <path_to_simavr> <cpu_part> <test_elf_file>)
+# Expect script to run an automated test within the AVR simulator (simavr) and
+# check for successful completion.
+#
+# Arguments: <path_to_simavr> <cpu_part> <test_elf_file>
+#
+# Returns 0 on successful test run within AVR simulator, 1 on failure
+
+
+# Start the test
 spawn [lindex $argv 0] -m [lindex $argv 1] [lindex $argv 2]
 
 # Expect to see the test starting within 10 seconds