From 2daf9120e7a8be04be6ccfdb4ec9b37d1794f762 Mon Sep 17 00:00:00 2001
From: Tri Lam <tri@maydow.com>
Date: Mon, 1 Jun 2026 15:02:50 -0700
Subject: [PATCH] docs(config): document pattern-prefixed knob naming (#379)

New per-pattern knobs MUST use <Pattern><Knob> prefix. Bare names (NCCLHangThreshold etc.) kept for backward-compat with pre-v0.4 values.yaml; no rename in v1.0-rc1. v2.0 may nest. Closes #379.

Signed-off-by: Tri Lam <tri@maydow.com>
---
 module/processor/patterndetectorprocessor/config.go | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/module/processor/patterndetectorprocessor/config.go b/module/processor/patterndetectorprocessor/config.go
index 2524aa5a..8c20e50a 100644
--- a/module/processor/patterndetectorprocessor/config.go
+++ b/module/processor/patterndetectorprocessor/config.go
@@ -1,5 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 
+// Knob naming convention:
+//   - New per-pattern knobs MUST use the prefixed form: <Pattern><Knob>
+//     (e.g. CheckpointerHangBackwardWindow, DataLoaderHangStallThreshold).
+//   - Bare names (NCCLHangThreshold, XidCorrelationWindow, HBMECCWindow,
+//     ThermalThrottleWindow, PCIeAERWindow, IBLinkFlapWindow,
+//     CUDAOOMCorrelationWindow, JoinWindow) exist for backward-compat with
+//     pre-v0.4 values.yaml; do not rename in v1.0-rc1.
+//   - v2.0 may nest into per-pattern blocks (see issue #379).
 package patterndetectorprocessor
 
 import (