[PATCH proxmox] fix #8127: notify: matcher: fix description of match-calendar

[PATCH proxmox] fix #8127: notify: matcher: fix description of match-calendar

[Lucas Barros]

The doc comment of the 'match-calendar' property was copied from
'match-severity', so the API schema, and with it the CLI help and the
man page of 'proxmox-backup-manager notification matcher create' and
'update', describes it as a list of matched severity levels. The
option matches the timestamp of a notification against calendar
entries, though.

Use a description that fits what the option does.

Signed-off-by: Lucas Barros <lucasbarros.kam@gmail.com>
---

The 'match-severity' doc comment right above it is correct and left as
is. The items description of the same property in the api macro
("Time stamps to match") is left alone as well.

Doc comment change only. I did not build the crate locally (no Rust
toolchain on this machine).

This patch was prepared with the help of an LLM based coding assistant; I
reviewed the change and ran the tests mentioned above myself.

 proxmox-notify/src/matcher/mod.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/proxmox-notify/src/matcher/mod.rs b/proxmox-notify/src/matcher/mod.rs
index 59be88f..af87a4e 100644
--- a/proxmox-notify/src/matcher/mod.rs
+++ b/proxmox-notify/src/matcher/mod.rs
@@ -93,7 +93,7 @@ pub struct MatcherConfig {
     #[cfg(feature = "legacy-matchers")]
     pub match_severity: Vec<severity::InlineSeverityMatcher>,
 
-    /// List of matched severity levels.
+    /// List of matched calendar entries.
     #[serde(default, skip_serializing_if = "Vec::is_empty")]
     #[updater(serde(skip_serializing_if = "Option::is_none"))]
     #[cfg(feature = "legacy-matchers")]
-- 
2.50.1 (Apple Git-155)

Re: [PATCH proxmox] fix #8127: notify: matcher: fix description of match-calendar

[Christian Ebner]

On 11/7/26 11:35 PM, Lucas Barros wrote:
> The doc comment of the 'match-calendar' property was copied from
> 'match-severity', so the API schema, and with it the CLI help and the
> man page of 'proxmox-backup-manager notification matcher create' and
> 'update', describes it as a list of matched severity levels. The
> option matches the timestamp of a notification against calendar
> entries, though.
> 
> Use a description that fits what the option does.
> 
> Signed-off-by: Lucas Barros <lucasbarros.kam@gmail.com>
Thanks for your contribution.

Tested that the correct string is now shown in docs and return type in 
API viewer.

Acked-by: Christian Ebner <c.ebner@proxmox.com>
Tested-by: Christian Ebner <c.ebner@proxmox.com>