summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorBrian Potchik <brian@vector35.com>2020-12-09 23:40:08 -0500
committerBrian Potchik <brian@vector35.com>2020-12-09 23:40:08 -0500
commitfadc9bee32581b7890ab1b896ecd6392d22c48a6 (patch)
tree4a7b4ae226b219d14e2192d4dcf8e982391f3a8b /python
parentf184af8b393b789f29fd7974c7c8766874daa5f4 (diff)
Update settings documentation.
Diffstat (limited to 'python')
-rw-r--r--python/settings.py16
1 files changed, 8 insertions, 8 deletions
diff --git a/python/settings.py b/python/settings.py
index 8bb87f80..e7f41ef5 100644
--- a/python/settings.py
+++ b/python/settings.py
@@ -49,14 +49,14 @@ class Settings(object):
backing store. The backing store can be different for each level. When querying setting values, the values returned or modified \
are in order of preference (i.e. ``SettingsAutoScope``). It is possible to override the scope by specifying the desired ``SettingsScope``.
- ================= ========================== ============== ================================ ===============================
- Setting Level Settings Scope Preference Backing Store ('default') Backing Store (Other)
- ================= ========================== ============== ================================ ===============================
- Default SettingsDefaultScope Lowest Settings Schema Settings Schema
- User SettingsUserScope - <User Directory>/settings.json <TBD>
- Project SettingsProjectScope - <TBD> <TBD>
- Resource SettingsResourceScope Highest BinaryView (Storage in BNDB) SettingsResource (Customizable)
- ================= ========================== ============== ================================ ===============================
+ ================= ========================== ============== ==============================================
+ Setting Level Settings Scope Preference Storage
+ ================= ========================== ============== ==============================================
+ Default SettingsDefaultScope Lowest Settings Schema
+ User SettingsUserScope - <User Directory>/settings.json
+ Project SettingsProjectScope - <Project Directory>/.binaryninja/settings.json
+ Resource SettingsResourceScope Highest BinaryView (Storage in BNDB)
+ ================= ========================== ============== ==============================================
Individual settings are identified by a key, which is a string in the form of **'<group>.<name>'**. Groups provide a simple way \
to categorize settings. Additionally, sub-categories can be expressed directly in the name part of the key with a similar dot notation.