Bug 1135 - No documentation for dconf/gsetting/ini values
Status:
NEW
Component:
WWW
Version:
1.10
Hardware:
All Linux
Importance:
P5 normal
Target Milestone:
---
Assignee:
Raymond Penners
URL:
Depends on:
Blocks:
Reported:
Dec 4 2013 11:49:50 UTC
by:
d3vid seaward
Modified:
Feb 4 2014 08:35:27 UTC
CC List:
Rob Caelers
| Who | When | What | Removed | Added |
|---|---|---|---|---|
| d3vid seaward | Jan 24 2014 13:54:29 UTC | summary | No documentation for gsetting/ini values | No documentation for dconf/gsetting/ini values |
| Rob Caelers | Feb 3 2014 20:18:12 UTC | cc | Rob Caelers |
Description
d3vid seaward Dec 4 2013 11:49:50 UTC
It appears that configuration is done using gsetting values or an .ini file. However, there is no single set of documentation for these values. For example, what are org.workrave.general.operation-mode and org.workrave.general.usage-mode?
Comment 1
d3vid seaward Jan 24 2014 13:53:07 UTC
*** Bug 1142 has been marked as a duplicate of this bug. ***
Comment 2
d3vid seaward Jan 24 2014 13:54:29 UTC
Linked duplicate is about dconf settings not containing summary, description and default values.
Comment 3
d3vid seaward Jan 31 2014 12:21:40 UTC
It looks like operation-mode refers to Normal (0), Quiet (2) and Suspended (1) modes, and usage-mode refers to Reading Mode being off (0) or on (1). (Discovered by watching dconf editor while changing these settings, and changing settings in dconf editor and seeing changes in app indicator.)
Comment 4
Rob Caelers Feb 3 2014 20:18:12 UTC
Workrave's settings were never designed to be an external API: - Many settings use numeric values instead of more user readable strings. - Workrave does not extensively check the values it reads. Incorrect values may result in unspecified behaviour. This is also one of the reasons I never documented the settings. But feel free to document the schema files. It is not very high on my todo list...
Comment 5
d3vid seaward Feb 4 2014 08:35:27 UTC
Thanks for the feedback Rob, I understand this is not a common use case. It looks like the relevant file would be: workrave / frontend / gtkmm / src / org.workrave.gui.gschema.xml.in.in ?