Skip to content

Commit 052da8d

Browse files
authored
Merge pull request #3187 from mdavidsaver/doc-pref-key
Add example of preference key construction
2 parents b1bcfd5 + f4f7118 commit 052da8d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/source/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,11 @@ def createPreferenceAppendix(root):
333333
The following preference settings are available for the various application features.
334334
To use them in your settings file, remember to prefix each setting with the package name.
335335
336+
eg. for the 'drop_failed_archives' preference in the 'trends.databrowser3' section
337+
(package name 'org.csstudio.trends.databrowser3') add a line like: ::
338+
339+
org.csstudio.trends.databrowser3/drop_failed_archives=true
340+
336341
""")
337342
for pack in sorted(pref_files.keys()):
338343
pref_file = pref_files[pack]

0 commit comments

Comments
 (0)