Skip to content

Commit

Permalink
Merge pull request #3187 from mdavidsaver/doc-pref-key
Browse files Browse the repository at this point in the history
Add example of preference key construction
  • Loading branch information
kasemir authored Nov 12, 2024
2 parents b1bcfd5 + f4f7118 commit 052da8d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,11 @@ def createPreferenceAppendix(root):
The following preference settings are available for the various application features.
To use them in your settings file, remember to prefix each setting with the package name.
eg. for the 'drop_failed_archives' preference in the 'trends.databrowser3' section
(package name 'org.csstudio.trends.databrowser3') add a line like: ::
org.csstudio.trends.databrowser3/drop_failed_archives=true
""")
for pack in sorted(pref_files.keys()):
pref_file = pref_files[pack]
Expand Down

0 comments on commit 052da8d

Please sign in to comment.