test-manifest-toml.rst (1616B)
1 Test Manifest TOML 2 ================== 3 4 This linter verifies syntax for ManifestParser TOML files. 5 6 Run Locally 7 ----------- 8 9 This mozlint linter can be run using mach: 10 11 .. parsed-literal:: 12 13 $ mach lint --linter test-manifest-toml <file paths> 14 15 16 Configuration 17 ------------- 18 19 The configuration excludes all non-ManifestParser TOML files (as well as 20 generated TOML manifests). 21 22 Sources 23 ------- 24 25 * `Configuration (YAML) <https://searchfox.org/mozilla-central/source/tools/lint/test-manifest-toml.yml>`_ 26 * `Source <https://searchfox.org/mozilla-central/source/tools/lint/test-manifest-toml/__init__.py>`_ 27 28 Errors Detected 29 --------------- 30 * Invalid TOML 31 * Missing DEFAULT section (fixable) 32 * Sections not in alphabetical order (fixable) 33 * Section name not double quoted (fixable) 34 * Disabling a path by commenting out the section 35 * Conditional contains explicit || 36 * Conditional is NOT an array 37 * Missing include file 38 39 Non idiomatic manifest warnings 40 ------------------------------- 41 * Using ``processor`` instead of ``arch`` 42 * Using ``bits`` instead of ``arch`` 43 * Using ``android_version`` instead of ``os_version`` 44 * Using platform combination variables: ``apple_catalina``, ``apple_silicon``, ``win10_2009``, ``win11_2009`` (unused) 45 * Platforms no longer used by CI: ``Linux 18.04``, ``MacOS 11.20``, ``Windows 11.2009`` 46 * Specifying display ``x11`` on Linux 22.04 where only ``wayland`` is supported 47 * Specifying display ``wayland`` on Linux 24.04 where only ``x11`` is supported 48 * Using ``!debug`` instead of ``asan``, ``opt``, or ``tsan`` 49 * Using literal boolean values for single variables like ``debug == false``