mirrors/cmake
2
0
Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-09-25 04:09:36 +03:00
Code Activity

Presets: Fix generation of diagnostics schema

Browse Source 
The description of diagnostics presets needs both the presets schema
spelling and the command-line spelling, but the initial generation logic
only used the former. This wasn't noticed because the spellings are the
same for single-word diagnostics, which were previously the only ones
being generated. Add the command-line spelling and update the
description templates.
This commit is contained in:
Matthew Woehlke
2026-04-20 15:34:12 -04:00
parent f0d5a282da
commit d3102b165a
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Utilities/Scripts/regenerate-presets.py
+16 -10
View File
@@ -46,31 +46,36 @@ CONFIGURE_PRESET_PROPERTIES_PATH = (
WARNING_DESCRIPTION = (
'An optional boolean. '
'Equivalent to passing -W{c} or -Wno-{c} on the command line. '
'This may not be set to false if errors.{c} is set to true.'
'This may not be set to false if errors.{p} is set to true.'
)
WARNING_SPHINX_DESCRIPTION = """
An optional boolean. Equivalent to passing :option:`-W{c} <cmake -W>` or
:option:`-Wno-{c} <cmake -Wno->` on the command line.
This may not be set to ``false`` if ``errors.{c}`` is set to ``true``.
This may not be set to ``false`` if ``errors.{p}`` is set to ``true``.
""".strip()
ERROR_DESCRIPTION = (
'An optional boolean. '
'Equivalent to passing -Werror={c} or -Wno-error={c} on the command line. '
'This may not be set to true if warnings.{c} is set to false.'
'This may not be set to true if warnings.{p} is set to false.'
)
ERROR_SPHINX_DESCRIPTION = """
An optional boolean. Equivalent to passing :cmake-option:`-Werror={c}` or
:cmake-option:`-Wno-error={c}` on the command line.
This may not be set to ``true`` if ``warnings.{c}`` is set to ``false``.
This may not be set to ``true`` if ``warnings.{p}`` is set to ``false``.
""".strip()
# =============================================================================
@dataclass
class Diagnostic:
name: str
presetName: str
cliName: str
since: int
# -------------------------------------------------------------------------
def format(self, template: str) -> str:
return template.format(c=self.cliName, p=self.presetName)
# =============================================================================
class Value:
@@ -662,11 +667,11 @@ def buildDiagnosticsSchema(
out = {}
for d in diagnostics:
out[d.name] = {
out[d.presetName] = {
'since': d.since,
'type': 'boolean',
'description': descriptionTemplate.format(c=d.name),
'sphinxDescription': sphinxDescriptionTemplate.format(c=d.name),
'description': d.format(descriptionTemplate),
'sphinxDescription': d.format(sphinxDescriptionTemplate),
}
return out
@@ -720,10 +725,11 @@ def readDiagnostics(path: Path | str) -> list[Diagnostic]:
break
args = [a.strip() for a in m.group(1).split(',')]
n = diagnosticPresetName(args[3])
p = diagnosticPresetName(args[3])
c = args[3][4:].lower().replace('_', '-')
v = int(args[4])
if v > 1:
out.append(Diagnostic(n, v))
out.append(Diagnostic(p, c, v))
content = content[m.span()[1]:]