Updoc - Revision history

Kevin Reid: /* Running Updoc */ typo

2011-09-26T14:21:13Z

Running Updoc: typo

New page

''Updoc'' is a tool for creating checkable documentation and regression tests.

Please read more about it here: http://www.erights.org/elang/tools/updoc.html

==[[:Category:E specification|E specification]]==

The E specification contained in this wiki incorporates a test suite written in Updoc.

==Running Updoc==

In [[E-on-Java]], the program <code>scripts/updoc.e</code> runs Updoc tests. It takes one argument which is an Updoc file or a directory containing them. Updoc may be by itself, embedded in E source, or embedded in HTML.

{{XXX|Explain startup options}}

{{XXX|doc E-on-CL}}

==Updoc syntax and behavior==

{{XXX|write the rest of this}}

An updoc test failure occurs when the actual answers resulting from evaluation are not equal (except for stack traces) to the expected answers written in the test script.

{{XXX|Note: E-on-Java currently permits the actual "value" answer to be anything if the script does not contain one. We have decided that this behavior is too hazardous (hiding leaks) but it has not yet been fixed.}}

===Parsing===

Exactly like an interactive session, parser pragmas persist from one step to the next.

? accum [] for _ in "" { _ + [1] }; null
# syntax error: The optional e.enable.accumulator feature (see org/erights/e/elang/syntax/syntax-props-default.txt) is currently off.

? pragma.enable("accumulator")
? accum [] for _ in "" { _ + [1] }; null
? pragma.syntax("0.9")
? accum [] for _ in "" { _ + [1] }; null
# syntax error: The optional e.enable.accumulator feature (see org/erights/e/elang/syntax/syntax-props-default.txt) is currently off.

===Printing===

In the Updoc [[environment]], the text printed via the output objects <code>stdout</code>, <code>stderr</code>, <code>print</code>, and <code>println</code> is part of the results checked.

Semantics: stdout and stderr write to separate buffers. At the following times in the execution of each step, the contents of each buffer, if nonempty, are moved into answers named "stdout" and "stderr":
* after evaluation of the step, but before the <code>value</code> is printed
* after interp.waitAtTop/blockAtTop pauses and after all turns queued by the step have executed, but before the evaluation of the next step

{{XXX|Review whether this definition matches E-on-CL and E-on-Java}}

Line breaks and buffers:

? stdout.print("a")
# stdout: a

? stdout.print("a\n")
# stdout: a
#

? stdout.print("a"); stderr.print("b")
# stdout: a

# stderr: b

Timing:

? stdout.print("a"); stdout <- print("b"); "c"
# stdout: a

# value: "c"

# stdout: b

? # This step should have no output.

<code>print</code> and <code>println</code>:

? println("a", "b"); print("c", "d")
# stdout: ab
# cd

{{stub}}
[[Category:E specification]]

Kevin Reid: stub section

2011-09-26T14:18:38Z

stub section

←Older revision		Revision as of 14:18, 26 September 2011
Line 6:		Line 6:

	The E specification contained in this wiki incorporates a test suite written in Updoc.		The E specification contained in this wiki incorporates a test suite written in Updoc.
		+
		+	==Running Updoc==
		+
		+	In [[E-on-Java]], the program <code>scripts/updoc.e</scripts> runs Updoc tests. It takes one argument which is an Updoc file or a directory containing them. Updoc may be by itself, embedded in E source, or embedded in HTML.
		+
		+	{{XXX\|Explain startup options}}
		+
		+	{{XXX\|doc E-on-CL}}

	==Updoc syntax and behavior==		==Updoc syntax and behavior==

Kevin Reid: /* Updoc syntax and behavior */ pragmas persist

2009-08-06T21:30:40Z

Updoc syntax and behavior: pragmas persist

←Older revision		Revision as of 21:30, 6 August 2009
Line 14:		Line 14:

	{{XXX\|Note: E-on-Java currently permits the actual "value" answer to be anything if the script does not contain one. We have decided that this behavior is too hazardous (hiding leaks) but it has not yet been fixed.}}		{{XXX\|Note: E-on-Java currently permits the actual "value" answer to be anything if the script does not contain one. We have decided that this behavior is too hazardous (hiding leaks) but it has not yet been fixed.}}
		+
		+	===Parsing===
		+
		+	Exactly like an interactive session, parser pragmas persist from one step to the next.
		+
		+	? accum [] for _ in "" { _ + [1] }; null
		+	# syntax error: The optional e.enable.accumulator feature (see org/erights/e/elang/syntax/syntax-props-default.txt) is currently off.
		+
		+	? pragma.enable("accumulator")
		+	? accum [] for _ in "" { _ + [1] }; null
		+	? pragma.syntax("0.9")
		+	? accum [] for _ in "" { _ + [1] }; null
		+	# syntax error: The optional e.enable.accumulator feature (see org/erights/e/elang/syntax/syntax-props-default.txt) is currently off.

	===Printing===		===Printing===

70.21.116.4: /* Printing */ fix typo in test

2009-07-17T16:16:53Z

Printing: fix typo in test

←Older revision		Revision as of 16:16, 17 July 2009
Line 46:		Line 46:
	# value: "c"		# value: "c"

-	# stdout: c	+	# stdout: b

	? # This step should have no output.		? # This step should have no output.

Kevin Reid: multi arg print(), timing buffer step, mention EoJ # value: behavior

2009-07-03T04:41:46Z

multi arg print(), timing buffer step, mention EoJ # value: behavior

←Older revision		Revision as of 04:41, 3 July 2009
Line 12:		Line 12:

	An updoc test failure occurs when the actual answers resulting from evaluation are not equal (except for stack traces) to the expected answers written in the test script.		An updoc test failure occurs when the actual answers resulting from evaluation are not equal (except for stack traces) to the expected answers written in the test script.
		+
		+	{{XXX\|Note: E-on-Java currently permits the actual "value" answer to be anything if the script does not contain one. We have decided that this behavior is too hazardous (hiding leaks) but it has not yet been fixed.}}

	===Printing===		===Printing===
Line 45:		Line 47:

	# stdout: c		# stdout: c
		+
		+	? # This step should have no output.

	<code>print</code> and <code>println</code>:		<code>print</code> and <code>println</code>:

-	? println("a"); print("b")	+	? println("a", "b"); print("c", "d")
-	# stdout: a	+	# stdout: ab
-	# b	+	# cd

	{{stub}}		{{stub}}
	[[Category:E specification]]		[[Category:E specification]]

Kevin Reid: /* Printing */ add print functions

2009-07-03T03:20:21Z

Printing: add print functions

←Older revision		Revision as of 03:20, 3 July 2009
Line 22:		Line 22:

	{{XXX\|Review whether this definition matches E-on-CL and E-on-Java}}		{{XXX\|Review whether this definition matches E-on-CL and E-on-Java}}
		+
		+	Line breaks and buffers:

	? stdout.print("a")		? stdout.print("a")
Line 34:		Line 36:

	# stderr: b		# stderr: b
-		+
		+	Timing:
		+
	? stdout.print("a"); stdout <- print("b"); "c"		? stdout.print("a"); stdout <- print("b"); "c"
	# stdout: a		# stdout: a
Line 41:		Line 45:

	# stdout: c		# stdout: c
		+
		+	<code>print</code> and <code>println</code>:
		+
		+	? println("a"); print("b")
		+	# stdout: a
		+	# b

	{{stub}}		{{stub}}
	[[Category:E specification]]		[[Category:E specification]]

Kevin Reid: add printing spec

2009-07-02T23:23:16Z

add printing spec

←Older revision		Revision as of 23:23, 2 July 2009
Line 1:		Line 1:
	''Updoc'' is a tool for creating checkable documentation and regression tests.		''Updoc'' is a tool for creating checkable documentation and regression tests.

-	Please read more about it here:	+	Please read more about it here: http://www.erights.org/elang/tools/updoc.html

-	~~http~~://~~www~~.~~erights~~.~~org~~/~~elang~~/~~tools/updoc~~.~~html~~	+	==[[:Category:E specification\|E specification]]==
		+
		+	The E specification contained in this wiki incorporates a test suite written in Updoc.
		+
		+	==Updoc syntax and behavior==
		+
		+	{{XXX\|write the rest of this}}
		+
		+	An updoc test failure occurs when the actual answers resulting from evaluation are not equal (except for stack traces) to the expected answers written in the test script.
		+
		+	===Printing===
		+
		+	In the Updoc [[environment]], the text printed via the output objects <code>stdout</code>, <code>stderr</code>, <code>print</code>, and <code>println</code> is part of the results checked.
		+
		+	Semantics: stdout and stderr write to separate buffers. At the following times in the execution of each step, the contents of each buffer, if nonempty, are moved into answers named "stdout" and "stderr":
		+	* after evaluation of the step, but before the <code>value</code> is printed
		+	* after interp.waitAtTop/blockAtTop pauses and after all turns queued by the step have executed, but before the evaluation of the next step
		+
		+	{{XXX\|Review whether this definition matches E-on-CL and E-on-Java}}
		+
		+	? stdout.print("a")
		+	# stdout: a
		+
		+	? stdout.print("a\n")
		+	# stdout: a
		+	#
		+
		+	? stdout.print("a"); stderr.print("b")
		+	# stdout: a
		+
		+	# stderr: b
		+
		+	? stdout.print("a"); stdout <- print("b"); "c"
		+	# stdout: a
		+
		+	# value: "c"
		+
		+	# stdout: c
		+
		+	{{stub}}
		+	[[Category:E specification]]

Ansible: this is a stub, but I had to put something

2006-12-10T16:33:25Z

this is a stub, but I had to put something

←Older revision		Revision as of 16:33, 10 December 2006
Line 1:		Line 1:
	''Updoc'' is a tool for creating checkable documentation and regression tests.		''Updoc'' is a tool for creating checkable documentation and regression tests.

-	Please read more about it here: ~~http://www.erights.org/elang/tools/updoc.html~~	+	Please read more about it here:

-	~~==[[~~:~~Category:E specification\|E specification]]==~~	+	http://www.erights.org/elang/tools/updoc.html
-		+
-	~~The E specification contained in this wiki incorporates a test suite written in Updoc.~~	+
-		+
-	~~==Running Updoc==~~	+
-		+
-	~~In [[E-on-Java]], the program <code>scripts~~/~~updoc.e<~~/~~code> runs Updoc tests~~. ~~It takes one argument which is an Updoc file or a directory containing them. Updoc may be by itself, embedded in E source, or embedded in HTML.~~	+
-		+
-	~~{{XXX\|Explain startup options}}~~	+
-		+
-	~~{{XXX\|doc E-on-CL}}~~	+
-		+
-	~~==Updoc syntax and behavior==~~	+
-		+
-	~~{{XXX\|write the rest of this}}~~	+
-		+
-	~~An updoc test failure occurs when the actual answers resulting from evaluation are not equal (except for stack traces) to the expected answers written in the test script.~~	+
-		+
-	{{XXX\|Note: E-on-Java currently permits the actual "value" answer to be anything if the script does not contain one. We have decided that this behavior is too hazardous (hiding leaks) but it has not yet been fixed.}}	+
-		+
-	~~===Parsing===~~	+
-		+
-	~~Exactly like an interactive session, parser pragmas persist from one step to the next.~~	+
-		+
-	~~? accum [] for _ in "" { _ + [1] }; null~~	+
-	~~# syntax error: The optional e.enable.accumulator feature (see org/~~erights~~/e/elang/syntax/syntax-props-default~~.~~txt) is currently off.~~	+
-		+
-	~~? pragma.enable("accumulator")~~	+
-	~~? accum [] for _ in "" { _ + [1] }; null~~	+
-	~~? pragma.syntax("0.9")~~	+
-	~~? accum [] for _ in "" { _ + [1] }; null~~	+
-	~~# syntax error: The optional e.enable.accumulator feature (see~~ org~~/erights/e~~/elang/~~syntax~~/~~syntax-props-default~~.~~txt) is currently off.~~	+
-		+
-	~~===Printing===~~	+
-		+
-	~~In the Updoc [[environment]], the text printed via the output objects <code>stdout</code>, <code>stderr</code>, <code>print</code>, and <code>println</code> is part of the results checked.~~	+
-		+
-	Semantics: stdout and stderr write to separate buffers. At the following times in the execution of each step, the contents of each buffer, if nonempty, are moved into answers named "stdout" and "stderr":	+
-	* after evaluation of the step, but before the <code>value</code> is printed	+
-	* after interp.waitAtTop/blockAtTop pauses and after all turns queued by the step have executed, but before the evaluation of the next step	+
-		+
-	~~{{XXX\|Review whether this definition matches E-on-CL and E-on-Java}}~~	+
-		+
-	~~Line breaks and buffers:~~	+
-		+
-	~~? stdout.print("a")~~	+
-	~~# stdout: a~~	+
-		+
-	~~? stdout.print("a\n")~~	+
-	~~# stdout: a~~	+
-	#	+
-		+
-	~~? stdout.print("a"); stderr.print("b")~~	+
-	~~# stdout: a~~	+
-		+
-	~~# stderr: b~~	+
-		+
-	~~Timing:~~	+
-		+
-	~~? stdout.print("a"); stdout <- print("b"); "c"~~	+
-	~~# stdout: a~~	+
-		+
-	~~# value: "c"~~	+
-		+
-	~~# stdout: b~~	+
-		+
-	~~? # This step should have no output.~~	+
-		+
-	~~<code>print</code> and <code>println</code>:~~	+
-		+
-	~~? println("a", "b"); print("c", "d")~~	+
-	~~# stdout: ab~~	+
-	~~# cd~~	+
-		+
-	~~{{stub}}~~	+
-	~~[[Category:E specification]]~~	+