The dev checkers documented themselves under headings nothing else uses
This commit is contained in:
@@ -13,16 +13,39 @@
|
||||
// php Tools/conf_widget_check.php assertions, then the live summary
|
||||
// php Tools/conf_widget_check.php --list every live field and its inferred control
|
||||
//
|
||||
// WHY IT ASSERTS AGAINST SNIPPETS AND NOT THE LIVE CONF
|
||||
// The live conf is the thing being described, so it cannot also be the thing that proves the
|
||||
// description right — an inference rule that silently stopped matching would keep passing as
|
||||
// the conf drifted to suit it. The snippets are frozen copies of each convention as written,
|
||||
// so a rule change that breaks one shows up here rather than as a wrong control on a page.
|
||||
// DESIGN PRINCIPLES
|
||||
// Assertions run against snippets, never against the live conf.
|
||||
// The live conf is the thing being described, so it cannot also be the thing that proves
|
||||
// the description right — an inference rule that silently stopped matching would keep
|
||||
// passing as the conf drifted to suit it. The snippets are frozen copies of each
|
||||
// convention as written, so a rule change that breaks one shows up here rather than as a
|
||||
// wrong control on a page.
|
||||
//
|
||||
// WHAT AN INFERENCE IS NOT
|
||||
// Consistent with confform.php, none of this validates. A number field carrying min and max is
|
||||
// a courtesy to whoever is typing, not a promise the value is sensible — the consuming script
|
||||
// still owns that question.
|
||||
// An inference is a drawing decision, not a validation.
|
||||
// Consistent with confform.php, none of this validates. A number field carrying min and
|
||||
// max is a courtesy to whoever is typing, not a promise the value is sensible — the
|
||||
// consuming script still owns that question.
|
||||
//
|
||||
// The live pass reports, it does not assert.
|
||||
// What this host's master.conf infers to is a description of that file, not a verdict on
|
||||
// it. Turning the live summary into pass/fail would make an unusual but legitimate
|
||||
// setting look like a defect.
|
||||
//
|
||||
// OPERATIONAL SAFEGUARDS
|
||||
// Read-only. Parses conf and reports; writes no conf, no store and no page.
|
||||
//
|
||||
// Exits non-zero only when a snippet assertion fails, so it can gate a commit without a real
|
||||
// conf's contents ever being able to break the build.
|
||||
//
|
||||
// Never renders. It reports which control would be drawn; the drawing stays in confform.php,
|
||||
// so this cannot disagree with the page by construction.
|
||||
//
|
||||
// RUNTIME MODES
|
||||
// php Tools/conf_widget_check.php assertions, then the live summary
|
||||
// php Tools/conf_widget_check.php --list every live field and its inferred control
|
||||
//
|
||||
// Hand-run. Not scheduled and in no orchestrator — run it after touching _vv_conf_widget(),
|
||||
// after adding a conf convention, or when a setting draws as the wrong control.
|
||||
//
|
||||
// DEPENDS ON
|
||||
// include/confform.php _vv_conf_parse_field_range(), vv_conf_key_is_secret()
|
||||
|
||||
Reference in New Issue
Block a user