quirks: reword the requirements section in the quirks README
authorPeter Hutterer <peter.hutterer@who-t.net>
Tue, 2 Feb 2021 23:36:29 +0000 (09:36 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Wed, 3 Feb 2021 07:45:12 +0000 (07:45 +0000)
Change the wording from "these will fail" to "this must be followed" which is
easier to understand. And add the requirement for uppercase hex numbers as
enforced since c412924003b3154.

Related #568

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
quirks/README.md

index 4ff3e81b2e07c02d7ffc809d8c03595e366dcccd..f970cbe66b8a1f6dee59981cb3790ce357ccc57f 100644 (file)
@@ -66,15 +66,18 @@ All `Attr` tag values are specific to that attribute.
 Parser errors
 -------------
 
-The following will cause parser errors and are considered invalid data
-files:
-
-* Whitespace at the beginning of the line
-* Sections without a `Match*` entry
-* Sections with the same `Match*` entry repeated
-* Sections without at least one of `Model*` or `Attr` entries
-* A `Model` tag with a value other than `1` or `0`
-* A string property with enclosing quotes
+The following requirements must be met:
+
+* No whitespace is allowed at the beginning of the line
+* A Section must have at least one `Match*` entry
+* A Section must not repeat `Match*` entry
+* A Section must have at least one of `Model*` or `Attr*` entries
+* A `Model` tag may only have the value `1` or `0`
+* String properties must not be enclosed in quotes
+* Hex numbers must use uppercase letters (e.g. `0x12AB`)
+
+Failure to meet these requirements will cause a parser error and the quirks
+files will not be used.
 
 Debugging
 ---------