Bug 1586742 [wpt PR 19548] - [docs] Add documentation for common/, a=testonly
authorSimon Pieters <zcorpan@gmail.com>
Mon, 14 Oct 2019 13:39:01 +0000
changeset 559547 5f0b43a83a0c7c11286e149f65e7be63a0cdeea7
parent 559546 329d93800a86b390d14fe2b389b461974390251b
child 559548 90449bec1de2cdf9733993b00810b4b5faf31d91
push id12177
push usercsabou@mozilla.com
push dateMon, 21 Oct 2019 14:52:16 +0000
treeherdermozilla-beta@1918a9cd33bc [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerstestonly
bugs1586742, 19548, 17913
milestone71.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1586742 [wpt PR 19548] - [docs] Add documentation for common/, a=testonly Automatic update from web-platform-tests [docs] Add documentation for common/ Part of #17913. -- wpt-commits: 2ae499f937640068f33d547423bfeb8c3dbf5295 wpt-pr: 19548
testing/web-platform/tests/common/README.md
testing/web-platform/tests/common/security-features/README.md
new file mode 100644
--- /dev/null
+++ b/testing/web-platform/tests/common/README.md
@@ -0,0 +1,12 @@
+The files in this directory are non-infrastructure support files that can be used by tests.
+
+* `blank.html` - An empty HTML document.
+* `css-red.txt` - A text/plain "CSS" document.
+* `domain-setter.sub.html` - An HTML document that sets `document.domain`.
+* `dummy.xhtml` - An XHTML document.
+* `dummy.xml` - An XML document.
+* `entities.json` - All named character references in HTML.
+* `text-plain.txt` - A text/plain document.
+* `*.js` - Utility scripts. These are documented in the source.
+* `*.py` - wptserve [Python Handlers](https://web-platform-tests.org/writing-tests/python-handlers/). These are documented in the source.
+* `security-features` - Documented in `security-features/README.md`.
--- a/testing/web-platform/tests/common/security-features/README.md
+++ b/testing/web-platform/tests/common/security-features/README.md
@@ -28,17 +28,17 @@ They have the same object format as desc
 `common/security-features/resources/common.js` comments, and are directly
 serialized to generated HTML files and passed to JavaScript test code,
 except that:
 
 - The first entry of `sourceContextList`'s `sourceContextType` should be
   always `top`, which represents the top-level generated test HTML.
   (This entry is omitted in the JSON passed to JavaScript, but
   the policy deliveries specified here are written as e.g.
-  <meta> elements in the generated test HTML or HTTP headers)
+  `<meta>` elements in the generated test HTML or HTTP headers)
 - Instead of `PolicyDelivery` object (in `sourceContextList` or
   `subresourcePolicyDeliveries`), following placeholder strings can be used.
 
 The keys of `source_context_list_schema` can be used as the values of
 `source_context_list` fields, to indicate which source context configuration
 to be used.
 
 ## PolicyDelivery placeholders