You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update USAGE.md with current text format and workflow guides
- Fix --format text example and status table to match actual output
(multi-line per-feature blocks, real support level values incl. unknown)
- Add guide: contributing a new server profile to caldav/compatibility_hints.py
- Add guide: storing checker results in ~/.config/caldav/calendar.conf
(named profile, inline features, and base+overrides patterns)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: CHANGELOG.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,13 @@ This file should adhere to [Keep a Changelog](https://keepachangelog.com/en/1.1.
6
6
7
7
This project should adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), though some earlier releases may be incompatible with the SemVer standard.
8
8
9
+
## [Unreleased]
10
+
11
+
### Documentation
12
+
- USAGE.md: updated `--format text` section to reflect current multi-line output format and actual support-level values; added `unknown` status
13
+
- USAGE.md: added guide for contributing a new server profile to `caldav/compatibility_hints.py`
14
+
- USAGE.md: added guide for storing checker results in `~/.config/caldav/calendar.conf` (named profile, inline features, and base+overrides patterns)
15
+
9
16
## [1.0.0] - 2026-03-15
10
17
11
18
Considering this tool as "production ready" now - even though it's still lots of corner cases to be tested.
@@ -56,25 +56,36 @@ Note that the only difference between `--name` and `--config-section` is that `-
56
56
57
57
Human-readable summary. Without `--verbose`, only features deviating from the CalDAV standard are shown. With `--verbose`, all checked features are shown.
58
58
59
+
Each feature is reported as a block with up to three lines:
60
+
59
61
```
60
62
Server: radicale (http://localhost:5232/)
61
63
caldav library version: 1.5.0
62
64
63
65
Feature compatibility (non-verbose: showing only deviations from the standard):
64
-
[no] search.time-range.alarm
65
-
[quirk] search.unlimited-time-range
66
+
67
+
## search.time-range.alarm
68
+
Feature support level found: unsupported
69
+
70
+
## search.unlimited-time-range
71
+
Feature support level found: quirk
72
+
Extra check information:
73
+
behaviour=accepts-but-ignores-end-date
74
+
Description of the feature: Whether the server supports CalDAV REPORT search without an end date in a time-range filter
66
75
```
67
76
68
-
Status markers:
77
+
The **"Extra check information"** line describes the *specific behaviour observed* during testing — for example, what the server actually did when a feature was exercised (e.g. `behaviour=delayed-deletion`, `behaviour=mkcol-required`). This is distinct from the **"Description of the feature"** line, which gives the general definition of what the feature covers.
0 commit comments