aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Status_Reference.md
diff options
context:
space:
mode:
authorKurt Haenen <Misterke@users.noreply.github.com>2022-06-20 18:10:57 +0200
committerGitHub <noreply@github.com>2022-06-20 12:10:57 -0400
commitf2a5800cea0d87952af1a3e079eea9b3a7aaf43c (patch)
tree019b9e2691c2a3acef5b85b39c019b0a5a514a5f /docs/Status_Reference.md
parent6af931c4e1c5bf6f9590d0d6ad13d76e2594de77 (diff)
downloadkutter-f2a5800cea0d87952af1a3e079eea9b3a7aaf43c.tar.gz
kutter-f2a5800cea0d87952af1a3e079eea9b3a7aaf43c.tar.xz
kutter-f2a5800cea0d87952af1a3e079eea9b3a7aaf43c.zip
configfile: Expose options awaiting to be saved (#5270)
Adds a save_config_pending_items to the status reported by configfile reflecting the items and values that a future SAVE_CONFIG would actually persist. Signed-off-by: Kurt Haenen <kurt.haenen@gmail.com>
Diffstat (limited to 'docs/Status_Reference.md')
-rw-r--r--docs/Status_Reference.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md
index a515901b..4cc7512f 100644
--- a/docs/Status_Reference.md
+++ b/docs/Status_Reference.md
@@ -41,6 +41,8 @@ The following information is available in the `configfile` object
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.
+- `save_config_pending_items`: Contains the sections and options that
+ were changed and would be persisted by a `SAVE_CONFIG`.
- `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