Skip to content

Commit 28ac74a

Browse files
committed
Refine trace command descriptions
Updated the trace command files to specify required operations explicitly. Improved documentation without modifying test data. Change-Id: If8ef44171bb5cc3cfee812d74cc33d55f6f1320b
1 parent 1d68fae commit 28ac74a

18 files changed

+19
-17
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ Trace files
111111
* They are short and simple.
112112
* We encourage to study them to see what tests are being performed.
113113
* XX is the trace number (1-17). CAT describes the general nature of the test.
114+
* All functions that need to be implemented are explicitly listed.
115+
* If a colon is present in the title, all functions mentioned afterwards must be correctly implemented for the test to pass.
114116
* `traces/trace-eg.cmd` : A simple, documented trace file to demonstrate the operation of `qtest`
115117

116118
## Debugging Facilities

traces/trace-01-ops.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test of insert_head and remove_head
1+
# Test of 'q_new', 'q_insert_head', and 'q_remove_head'
22
option fail 0
33
option malloc 0
44
new

traces/trace-02-ops.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test of insert_head, insert_tail, remove_head, remove_tail, and delete_mid
1+
# Test of 'q_new', 'q_insert_head', 'q_insert_tail', 'q_remove_head', 'q_remove_tail', and 'q_delete_mid'
22
option fail 0
33
option malloc 0
44
new

traces/trace-03-ops.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test of insert_head, insert_tail, remove_head, reverse and merge
1+
# Test of 'q_new', 'q_insert_head', 'q_remove_head', 'q_reverse', 'q_sort', and 'q_merge'
22
option fail 0
33
option malloc 0
44
new

traces/trace-04-ops.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test of insert_head, insert_tail, size, swap, and sort
1+
# Test of 'q_new', 'q_insert_tail', 'q_insert_head', 'q_remove_head', 'q_size', 'q_swap', and 'q_sort'
22
option fail 0
33
option malloc 0
44
new

traces/trace-05-ops.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test of insert_head, insert_tail, remove_head, reverse, size, swap, and sort
1+
# Test of 'q_new', 'q_free', 'q_insert_head', 'q_insert_tail', 'q_remove_head', 'q_reverse', 'q_size', 'q_swap', and 'q_sort'
22
option fail 0
33
option malloc 0
44
new

traces/trace-06-ops.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test of insert_head, insert_tail, delete duplicate, sort, descend and reverseK
1+
# Test of 'q_new', 'q_free', 'q_insert_head', 'q_insert_tail', 'q_remove_head', 'q_delete_dup', 'q_sort', 'q_descend', and 'q_reverseK'
22
new
33
ih RAND 4
44
it gerbil 3

traces/trace-07-string.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test of truncated strings
1+
# Test of truncated strings: 'q_new', 'q_free', 'q_insert_head', 'q_insert_tail', 'q_remove_head', 'q_reverse', and 'q_sort'
22
option fail 0
33
option malloc 0
44
new

traces/trace-08-robust.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test operations on empty queue
1+
# Test operations on empty queue: 'q_new', 'q_remove_head', 'q_reverse', 'q_size', and 'q_sort'
22
option fail 10
33
option malloc 0
44
new

traces/trace-09-robust.cmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Test remove_head with NULL argument
1+
# Test 'q_remove_head' with NULL argument: 'q_new', 'q_insert_head', and 'q_remove_head'
22
option fail 10
33
option malloc 0
44
new

0 commit comments

Comments
 (0)