Index: doc/package_config.md |
diff --git a/doc/package_config.md b/doc/package_config.md |
index 23db939b8101d7c846d29b8c8ae26c94e98e1189..bead8c7991b76db75c89e316d017907756419a3f 100644 |
--- a/doc/package_config.md |
+++ b/doc/package_config.md |
@@ -111,10 +111,10 @@ tags: |
### `test_on` |
-This field declares which platforms a test supports. It's usually applied to |
-[specific tags](#configuring-tags) rather than used at the top level. It takes a |
-[platform selector][] and only allows a test to run on platforms that match the |
-selector. |
+This field declares which platforms a test supports. It takes a |
+[platform selector][] and only allows tests to run on platforms that match the |
+selector. It's often used with [specific tags](#configuring-tags) to ensure that |
+certain features will only be tested on supported platforms. |
[platform selector]: https://github.com/dart-lang/test/blob/master/README.md#platform-selectors |
@@ -124,6 +124,16 @@ tags: |
promises: {test_on: "browser && !ie"} |
``` |
+The field can also be used at the top level of the configuration file to |
+indicate that the entire package only supports a particular platform. If someone |
+tries to run the tests on an unsupported platform, the runner will print a |
+warning and skip that platform. |
+ |
+```yaml |
+# This package uses dart:io. |
+test_on: vm |
+``` |
+ |
## Runner Configuration |
Unlike [test configuration](#test-configuration), runner configuration affects |