Skip to content

Commit 55cb5d4

Browse files
committed
update function settings context menu documentation after UI changes
1 parent a8b5351 commit 55cb5d4

File tree

2 files changed

+28
-24
lines changed

2 files changed

+28
-24
lines changed

docs/guide/settings.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -40,53 +40,57 @@ BinaryView Resource settings can be accessed through:
4040
* **Settings UI**: Use `[CMD/CTRL] .` to open Resource Settings (automatically selects the current BinaryView)
4141
* **Programmatically**: Use the [Settings API](https://api.binary.ninja/binaryninja.settings-module.html) with a BinaryView object as the resource parameter
4242

43-
## Resource Settings (Function)
43+
## Function Settings Context Menu
4444

45-
Binary Ninja supports function-level settings for fine-grained control over analysis parameters. Unlike BinaryView Resource settings which store a complete copy of all analysis settings, Function Resource settings use an inheritance-based storage model. Each function inherits settings from its BinaryView by default, and only stores settings in its own cache when customization is needed for that specific function.
45+
Binary Ninja provides a powerful context menu for managing function-specific settings directly from analysis views. Right-clicking in any analysis view (Graph, Linear, etc.) displays the **Function Settings** menu, which offers quick access to three types of settings (a small dividing line separates each section from the other):
4646

47-
### Accessing Function Resource Settings
47+
![Function Settings Context Menu](../img/function-settings-context-menu.png)
4848

49-
Function Resource settings can be accessed through:
49+
### Resource Settings (Function)
5050

51-
* **Context Menu**: Right-click in any analysis view and select "Function Settings" to access a customizable submenu of boolean settings controlled by the Quick Settings system
52-
* **Programmatically**: Use the [Settings API](https://api.binary.ninja/binaryninja.settings-module.html) with a Function object as the resource parameter
51+
The first section contains special analysis settings designed to be changed per-function. Binary Ninja supports function-level settings for fine-grained control over analysis parameters. Unlike BinaryView Resource settings which store a complete copy of all analysis settings, Function Resource settings use an inheritance-based storage model. Each function inherits settings from its BinaryView by default, and only stores settings in its own cache when customization is needed for that specific function.
52+
53+
Function Resource settings can also be accessed programmatically using the [Settings API](https://api.binary.ninja/binaryninja.settings-module.html) with a Function object as the resource parameter.
5354

5455
!!! note
5556
Function-specific Resource settings are not currently accessible in the Settings UI Resource dropdown tab.
5657

57-
## Quick Settings
58+
### Workflow Eligibility Settings
59+
60+
The second section displays settings that can be enabled or disabled per-function to control workflow eligibility. These settings determine whether specific analysis workflows (such as WARP matching) are applied to individual functions. Examples include:
61+
62+
- **WARP GUID Generator**: Controls whether the function participates in WARP GUID generation
63+
- **WARP Apply Matched**: Controls whether matched WARP info is applied to the function
64+
65+
These workflow eligibility settings are automatically populated based on the available workflows in your Binary Ninja installation.
5866

59-
Quick Settings provide streamlined access to frequently used boolean analysis settings directly from the context menu within analysis views. This mechanism is designed for efficient per-function customization without requiring the full Settings UI.
67+
### Quick Settings
6068

61-
By default, no settings are included in the context menus. Individual settings must be explicitly marked for inclusion.
69+
The last section contains custom Quick Settings, which is empty by default. Quick Settings provide streamlined access to frequently used boolean analysis settings directly from the context menu. This mechanism is designed for efficient per-function customization without requiring the full Settings UI.
6270

63-
### Using Quick Settings in Context Menus
71+
#### Using Quick Settings
6472

65-
1. Right-click within any analysis view (Graph, Linear, etc.).
66-
2. The **Function Settings** submenu will appear, containing:
67-
- Function workflow eligibility settings (automatically added and configurable)
68-
- Manually added analysis settings for quick toggling in the Function Resource scope
69-
3. Toggle settings as needed. These changes apply only to the current function’s settings scope.
70-
4. Select "Reset Settings" to clear the function settings and revert to inherited settings from the BinaryView.
73+
1. Toggle settings as needed in the Function Settings menu. These changes apply only to the current function's settings scope.
74+
2. Select `Reset Settings` to clear the function settings and revert to inherited settings from the BinaryView.
7175

72-
### Adding Quick Settings
76+
#### Adding Quick Settings
7377

7478
1. Open the Settings UI
7579
2. Right-click any boolean setting
76-
3. Select Add to Quick Settings to add it to the quick access menu
80+
3. Select `Add to Quick Settings` to add it to the quick access menu
7781

78-
The setting will appear under the `Function Settings` submenu in applicable context menus.
82+
The setting will appear under the Quick Settings section in the Function Settings context menu.
7983

80-
### Removing Quick Settings
84+
#### Removing Quick Settings
8185

8286
1. Open the Settings UI
8387
2. Right-click on any boolean setting
84-
3. Uncheck Add to Quick Settings to remove it from the quick access menu
88+
3. Uncheck `Add to Quick Settings` to remove it from the quick access menu
8589

86-
### Resetting Quick Settings
90+
#### Resetting All Quick Settings
8791

8892
* Right-click within the Settings dialog.
89-
* Select Reset All Quick Settings
93+
* Select `Reset All Quick Settings`
9094

9195
## Settings Reference
9296

@@ -559,4 +563,4 @@ The setting will appear under the `Function Settings` submenu in applicable cont
559563
|updates|Show All Versions|Show all versions that are available for the current update channel in the UI.|`boolean`|`False`|[`SettingsUserScope`]|<a id='updates.showAllVersions'>updates.showAllVersions</a>|
560564
|updates|Use Enterprise Server For Updates|Use the enterprise server to check for updates. (Ultimate Only)|`boolean`|`False`|[`SettingsUserScope`]|<a id='updates.useEnterpriseServer'>updates.useEnterpriseServer</a>|
561565
|user|Email|The email that will be shown when collaborating with other users.|`string`| |[`SettingsUserScope`]|<a id='user.email'>user.email</a>|
562-
|user|Name|The name that will be shown when collaborating with other users.|`string`| |[`SettingsUserScope`]|<a id='user.name'>user.name</a>|
566+
|user|Name|The name that will be shown when collaborating with other users.|`string`| |[`SettingsUserScope`]|<a id='user.name'>user.name</a>|
72.9 KB
Loading

0 commit comments

Comments
 (0)