aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-09-04 14:20:24 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-09-16 13:44:54 -0400
commit46167cae672073b1ce0aeb4966b30c28bc47957e (patch)
tree52ea9318147b065b6848970e6821f7260e1f4190 /docs
parentc89db2480df57204d805f52c9c488e251bafe631 (diff)
downloadkutter-46167cae672073b1ce0aeb4966b30c28bc47957e.tar.gz
kutter-46167cae672073b1ce0aeb4966b30c28bc47957e.tar.xz
kutter-46167cae672073b1ce0aeb4966b30c28bc47957e.zip
configfile: Add support for reporting deprecated options
Add a new printer.configfile.warnings with a list of config features that are deprecated. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Status_Reference.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index 68abf2f6..049ddf1a 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -28,6 +28,12 @@ The following information is available in the `configfile` object
setting as read by Klipper during the last software start or
restart. (Any settings changed at run-time will not be reflected
here.) All values are returned as strings.
+- `save_config_pending`: Returns true if there are updates that a
+ `SAVE_CONFIG` command may persist to disk.
+- `warnings`: A list of warnings about config options. Each entry in
+ the list will be a dictionary containing a `type` and `message`
+ field (both strings). Additional fields may be available depending
+ on the type of warning.
## display_status