Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
xrchz committed Nov 9, 2017
1 parent 6c789a2 commit 5bdda16
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 12 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@ Automated regression test infrastructure for CakeML.

[api.sml](api.sml):
Implements the server-side regression-test API as a CGI program.
The API is for workers to view and manipulate the job queues.

[design.txt](design.txt):
Notes on the design of the automated regression test infrastructure.
[apiLib.sml](apiLib.sml):
The API that the server and worker agree on.

[poll.sml](poll.sml):
Implements automatic refreshing of the job queues.
If there are new jobs on GitHub, they will be added to the waiting queue.
If there are stale jobs, they will be removed.
[flock.sml](flock.sml):
Maintenance tool: acquire the lock that is used by the server to run a
command without interfering with the server.

[regressionLib.sml](regressionLib.sml):
Code shared between the pieces of the regression test suite.
[serverLib.sml](serverLib.sml):
Functions for manipulating the queues in the filesystem on the server,
including for getting information from GitHub with which to update them.

[utilLib.sml](utilLib.sml):
Small library of useful code.

[worker.sml](worker.sml):
Worker that claims and runs regression test jobs.
2 changes: 1 addition & 1 deletion apiLib.sml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
(*
API that server and worker agree on
The API that the server and worker agree on.
Reference:
Expand Down
4 changes: 2 additions & 2 deletions flock.sml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
(*
Acquire the lock that is used by the server to run a command without
interfering with the server
Maintenance tool: acquire the lock that is used by the server to run a
command without interfering with the server.
*)
use "serverLib.sml";
open serverLib
Expand Down
3 changes: 3 additions & 0 deletions utilLib.sml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
(*
Small library of useful code.
*)
structure utilLib = struct

fun equal x y = x = y
Expand Down

0 comments on commit 5bdda16

Please sign in to comment.