Some layout fixes

[lyx.git] / development / autotests / hello-world-in.txt

diff --git a/development/autotests/hello-world-in.txt b/development/autotests/hello-world-in.txt
index 1b5295e961e4ef2984addf4bcef892c6358b8ba6..019f293a1cf32b20a651450405007de7552202b1 100644 (file)
--- a/development/autotests/hello-world-in.txt
+++ b/development/autotests/hello-world-in.txt
@@ -13,12 +13,32 @@
 # TestBegin <args...>
 #   Starts a test case under deterministic conditions:
 #   Any currently running instance of LyX is killed
-#   A new LyX instance is spawned, with the command-line args <args...>
+#   A new LyX instance is spawned, with the command-line arguments
+#   specified in <args...>.
+#
+# TestEndWithKill <cmd...>
+#   Ends a test case, killing immidiately the LyX instance under test
+#   Behaviour is otherwise the same as in 'TestEnd' below
 #
 # TestEnd <cmd...>
-#   Ends a test case, killing the LyX instance under test, and
+#   Ends a test case, closing the LyX instance under test, and
 #   executing the <cmd...> commands into an os.system(). The exit status
-#   of the commands sequence determines success or failure of the test
+#   of the commands sequence determines success or failure of the test.
+#   This is equivalent to:
+#     TestEnd
+#     Assert <cmd...>
+#
+# Assert <cmd...>
+#   Executes the <cmd...> commands into an os.system() and, if the
+#   exit status is non-zero, then abort the test execution making it fail.
+#
+# Lang <lang>
+#   Sets the environment variable LANG to <lang>. Useful before launching
+#   LyX (i.e., before a TestBegin command, in order to set deterministically
+#   the language settings, which impacts the actual key sequences needed to
+#   operate within LyX. This way, different developers can write different
+#   test cases in different languages and still they can be executed by
+#   anyone.
 #
 # KK: <chars...>
 #   Feeds the running LyX instance with the specified key characters.
@@ -28,15 +48,47 @@
 #     \[Tab] ........ sends a Tab character
 #     \[Return] ..... sends a Return
 #
+# KD: n
+#   Changes the delay among typed charactes to n milliseconds.
+#
+# CO: [>>] <filename>
+#    Open control file for write (or append if preceeded with '>>').
+#    This file will contain the search and comment strings.
+#    Used only by the script 'searchPatterns.pl' at the end of test
+#
+# CN: <notice>
+#    Write a comment-notice to the control file. Will be output when processed
+#    by 'searchPatterns.pl' script.
+#
+# CP: <pattern>
+#    Write a pattern to the control file. Special characters in this pattern
+#    will be escaped to create a suitable regex.
+#    The result will be applied on the lyx-log-file
+#
+# Cp: <pattern>
+#    It is an error if this pattern matches before the expected (either CP: or CR:)
+#    Expand pattern like in CP:
+#
+# CR: <regex pattern>
+#    Write a pattern to the control file. Pattern will be used directly (no conversion).
+#
+# Cr: <regex pattern>
+#    It is an error if this pattern matches before the expected (either CP: or CR:)
+#
+# CC:
+#    Close the control file. The file is also closed at 'TestEndWithKill' and 'TestEnd'
+#    implicitly.
+#
+# Sleep f
+#   Single delay of f seconds.
+#
 #
 # This example instructs LyX to type "Hello World", then exports it as
 # LaTeX, and verifies that the typed characters are indeed present in the
 # exported document.
 #
-Exec rm -f /tmp/test.lyx /tmp/test.tex
-TestBegin /tmp/test.lyx 2> /tmp/log 2>&1
+TestBegin test.lyx -dbg key > hello-world.loga.txt 2>&1
 KK: Hello World
-KK: \Afs
-KK: \Ax
-KK: buffer-export latex\[Return]
-TestEnd grep "Hello World" /tmp/test.tex
+KK: \Cs
+KK: \Axbuffer-export latex\[Return]
+TestEnd grep "Hello World" test.tex