Add note on subdirectory's irrelevance to ordering

This commit is contained in:
cyqsimon 2024-01-18 23:26:00 +08:00
parent 9f36a7a284
commit c0f2d6f934
No known key found for this signature in database
GPG Key ID: 1D8CE2F297390D65
1 changed files with 9 additions and 7 deletions

View File

@ -100,14 +100,16 @@ like this:
## Ordering
At compile time, all TOML files are processed in lexicographical filename order.
So `00-foo.toml` takes precedence over `10-bar.toml`, which takes precedence
over `20-baz.toml`, and so on. This may be occasionally useful for creating
high/low priority rules, such as in the aforementioned example of explicitly
mapping `*.conf` files to unknown.
At compile time, all TOML files applicable to the target are processed in
lexicographical filename order. So `00-foo.toml` takes precedence over
`10-bar.toml`, which takes precedence over `20-baz.toml`, and so on. Note that
**only** the filenames of the TOML files are taken into account; the
subdirectories they are placed in have no influence on ordering.
Generally this should not be much of a concern, since rules should be written as
specifically as possible for each application.
This behaviour can be occasionally useful for creating high/low priority rules,
such as in the aforementioned example of explicitly mapping `*.conf` files to
unknown. Generally this should not be much of a concern though, since rules
should be written as specifically as possible for each application.
Rules within each TOML file are processed (and therefore matched) in the order
in which they are defined. At runtime, the syntax selection algorithm will