Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/KhronosGroup/SPIRV-Tools.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Neto <dneto@google.com>2017-01-27 23:30:09 +0300
committerDavid Neto <dneto@google.com>2017-01-30 06:53:50 +0300
commitab03b879cab5d09147c257035145f0ad36c45064 (patch)
tree600925b5c21de34a130a7d4d7347268a35c5467b /README.md
parentaffbc3184900322de6dd71057e258296d585666b (diff)
Encourage use of the validator
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6fc589dfe..4322b603e 100644
--- a/README.md
+++ b/README.md
@@ -61,8 +61,18 @@ See [`syntax.md`](syntax.md) for the assembly language syntax.
### Validator
-*Warning:* The validator is incomplete.
-Check the [CHANGES](CHANGES) file for reports on completed work, and
+The validator checks validation rules described by the SPIR-V specification.
+
+Khronos recommends that tools that create or transform SPIR-V modules use the
+validator to ensure their outputs are valid, and that tools that consume SPIR-V
+modules optionally use the validator to protect themselves from bad inputs.
+This is especially encouraged for debug and development scenarios.
+
+The validator has one-sided error: it will only return an error when it has
+implemented a rule check and the module violates that rule.
+
+The validator is incomplete.
+See the [CHANGES](CHANGES) file for reports on completed work, and
the [Validator
sub-project](https://github.com/KhronosGroup/SPIRV-Tools/projects/1) for planned
and in-progress work.