From: John Ousterhout <ouster@cs.stanford.edu>
Date: Fri, 1 May 2020 05:20:48 +0000 (-0700)
Subject: Document threads tests that may fail under jitter
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=40d17fa943ef0ced529b849faa79abfb278a1078;p=pintos-anon

Document threads tests that may fail under jitter
---

diff --git a/doc/threads.texi b/doc/threads.texi
index 5a18ec4..bf8546e 100644
--- a/doc/threads.texi
+++ b/doc/threads.texi
@@ -643,6 +643,17 @@ to cause many of the tests to fail.
 
 @xref{Testing}.
 
+@item Should I try running the tests with jitter?
+
+Using the jitter feature in Bochs (@pxref{Debugging versus Testing})
+is a great way to discover bugs that are timing dependent. However,
+the following tests are known to
+fail with jitter even if your code is correct: @code{alarm-simultaneous},
+@code{mlfqs-recent-1}, @code{mlfqs-fair-2}, @code{mlfqs-fair-20},
+@code{mlfqs-nice-2}, @code{mlfqs-nice-10}, and @code{priority-fifo}.
+The behavior of these tests can sometimes vary based on timing (e.g.,
+if a timer interrupt arrives at an inconvenient time).
+
 @item Why do I get a test failure in @func{pass}?
 
 @anchor{The pass function fails}