summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2024-02-26 15:38:45 -0500
committerJordan Wiens <jordan@psifertex.com>2024-02-26 15:38:45 -0500
commitbe6d9389670c931fae1fc5c58a847da51ffa1c93 (patch)
tree6c72bf62ac1d9e9e9837701ca58219e276476e34 /docs
parent86686b2901cba24a10fe77f570ad91a222b859a8 (diff)
add warning around improtlib in terms of which plugins dont work with it
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/concepts.md2
-rw-r--r--docs/dev/plugins.md2
-rw-r--r--docs/guide/settings.md2
3 files changed, 4 insertions, 2 deletions
diff --git a/docs/dev/concepts.md b/docs/dev/concepts.md
index 12284416..85e81da4 100644
--- a/docs/dev/concepts.md
+++ b/docs/dev/concepts.md
@@ -201,4 +201,4 @@ Several settings under analysis limits are relevant to identifying these strings
### Custom String Formats
-There is currently no support for custom types with different encoding mechanisms. Follow [#1334](https://github.com/Vector35/binaryninja-api/issues/1334) for more updates on when that feature is added. That said, it is possible to use a custom [DataRenderer](https://api.binary.ninja/binaryninja.datarender-module.html#binaryninja.datarender.DataRenderer) to improve the rendering using a custom type, but those strings will still not show up in the strings list or when included as variables in decompilation, only in linear view. \ No newline at end of file
+There is currently no support for custom types with different encoding mechanisms. Follow [#1334](https://github.com/Vector35/binaryninja-api/issues/1334) for more updates on when that feature is added. That said, it is possible to use a custom [DataRenderer](https://api.binary.ninja/binaryninja.datarender-module.html#binaryninja.datarender.DataRenderer) to improve the rendering using a custom type, but those strings will still not show up in the strings list or when included as variables in decompilation, only in linear view.
diff --git a/docs/dev/plugins.md b/docs/dev/plugins.md
index f489f94b..53a1dd87 100644
--- a/docs/dev/plugins.md
+++ b/docs/dev/plugins.md
@@ -35,6 +35,8 @@ The [`add_repository`](https://api.binary.ninja/binaryninja.pluginmanager-module
It's useful to be able to reload your plugin during testing. On the Commercial edition of Binary Ninja, this is easily accomplished with a stand-alone headless install using `import binaryninja` after [installing the API](https://github.com/Vector35/binaryninja-api/blob/dev/scripts/install_api.py). (install_api.py is included in each platforms respective [installation folder](../guide/index.md#binary-path))
+Additionally, some plugin types like Architectures or BinaryViews are only loaded at launch and cannot be reloaded during a running session.
+
For other plugins, we recommend the following workflow from the scripting console which enables easy iteration and testing:
```python
diff --git a/docs/guide/settings.md b/docs/guide/settings.md
index a4c2ef55..0db7bc28 100644
--- a/docs/guide/settings.md
+++ b/docs/guide/settings.md
@@ -442,4 +442,4 @@ All settings are uniquely identified with an identifier string. Identifiers are
| | | |`enum`|`core.function.objectiveC`| | |
| | | |`enum`|`core.module.defaultAnalysis`| | |
|workflows|Module Workflow|Workflow selection for module-based analysis. Note: Module-based workflows incomplete.|`string`|`core.module.defaultAnalysis`|[`SettingsProjectScope`, `SettingsResourceScope`, `SettingsUserScope`]|<a id='workflows.moduleWorkflow'>workflows.moduleWorkflow</a>|
-| | | |`enum`|`core.module.defaultAnalysis`| | | \ No newline at end of file
+| | | |`enum`|`core.module.defaultAnalysis`| | |