test/scripttest: [Per-Test Metadata]

jacobg · jacobg · commit 4c5fdf9199ec · 2012-06-15T18:42:01.000Z
diff --git a/test/scripttest.txt b/test/scripttest.txt
@@ -37,7 +37,7 @@ The discussion forum for the test harness is the W3C's cross-WG [[http://lists.w
 
 ==== Per-Test Metadata ====
 
-Additionally, test-specific metadata can be passed in the properties. These are used when the individual test has different metadata from that stored in the <head>. The recognized metadata properties are:
+Test-specific metadata can be passed in the properties object to the test constructor. These are used when an individual test has different metadata from that stored in the <head>. The recognized metadata properties are:
 
   * help - The url for the part of the specification being tested
   * assert - A human readable description of what the test is attempting to prove
@@ -56,4 +56,10 @@ test(function() { assert_true(true); },
 
 These values would override any metadata set in the <head> of the test and are only needed when the individual test's metadata is different from what's in the <head>.
 
-If there is only a single script test in a file, all metadata should be in the <head>.
+If there is only a single script test in a file, all metadata should be in the <head>.
+
+=== Metadata Cache  ===
+
+The default version of testharnessreport.js now contains code that reads your per-test metadata and compares it to the cached version. If the cache is not present, or is out of sync, it'll display a message to that effect and generate a link which, when clicked, will generate the appropriate source code for the cached metadata suitable for copy/paste into the test's <head>. The metadata cache need only be generated once just before submitting a test to suites that care about metadata, and regenerated only when the metadata changes.
+
+To access this functionality, launch your script test in a browser and follow the link that appears at the top of the page.
