Commit b4235c31 authored by Mark Canterbury's avatar Mark Canterbury
Browse files

Adding to README

parent 0bd7be4f
Loading
Loading
Loading
Loading
+20 −0
Original line number Original line Diff line number Diff line
@@ -92,3 +92,23 @@ As with `validate`, the JSON configuration can either contain a single dict givi
paths to a schema set and a list of instance documents to test against it, or can contain
paths to a schema set and a list of instance documents to test against it, or can contain
a list of the same. This allows multiple schema sets and their instance documents to
a list of the same. This allows multiple schema sets and their instance documents to
be tested in one pass.
be tested in one pass.

======= ============
Switch   Description
======= ============
-h      Shows help information
-c      Path to JSON config file (exclusive with -s)
-s      Path to core schema XSD file (exclusive with -c)
-u      Path to a supporting schema file (can be specified multiple times, ignored if -c is given)
-i      Path to an instance XML doc to be validated (can be specified multiple times, ignored if -c is given)
-j      Provide JSON output rather than tabular output
-q      Suppress all output (only return code indicates failure or success)
-v      Verbose. Can be specified multiple times. Ignored if -j or -q is specified
======= ============

The verbosity switch -v can be given multiple times for more verbose output.

- 0: A summary table is printed showing the number of validation targets (schema set + instance docs), total build failures, instance docs and validation failures
- 1: As 0, but a list of issues (build or validation errors) is printed first
- 2: As 1, but a summary of each validation target (build errors, validation errors) is printed first
- 3: As 2, but a detailed list of each file in each validation target is printed first
 No newline at end of file