Skip to content

Commit ecf9f12

Browse files
committed
warp docs cleanup
1 parent bd1a157 commit ecf9f12

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

docs/guide/warp.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# WARP
22

3-
Binary Ninja ships a first party plugin for [WARP] a format for transferring analysis
4-
information, such as function names and types. This integration is responsible for matching unique functions in a binary
5-
and automatically applying information to the analysis. As well as providing the user the ability to select from a set
6-
of possible functions, when identifying the unique function fails.
3+
Binary Ninja ships a first party plugin for [WARP], a format for transferring analysis information including function
4+
names, parameter names, and types. The plugin is responsible for matching unique functions in a binary and automatically
5+
applying information to the analysis. It also provides the user the ability to select from a set of possible functions
6+
when identifying the unique function fails.
77

88
The bundled plugin is open source and is located [here](https://github.com/Vector35/binaryninja-api/tree/dev/plugins/warp).
99

@@ -12,8 +12,8 @@ The bundled plugin is open source and is located [here](https://github.com/Vecto
1212
## How WARP Works
1313

1414
WARP works by making a function GUID based off the byte contents of the function. Because WARP creates this GUID based
15-
off the byte contents, the functions are expected to be an exact match, aside from variant instructions.
16-
To use WARP, you only need to know that the function GUID's must match across binaries for the function information to be considered.
15+
off the byte contents, the functions are expected to be an exact match, aside from variant instructions. To use WARP,
16+
you only need to know that the function GUID's must match across binaries for the function information to be considered.
1717

1818
To read more about how WARP works, please see the GitHub repository [here](https://github.com/vector35/warp).
1919

@@ -46,13 +46,14 @@ Files are automatically loaded from two locations when Binary Ninja starts:
4646
- Can be disabled using the setting `warp.container.loadUserFiles`.
4747

4848
???+ Danger "Warning"
49-
Always place your signature libraries in your user directory. The installation path is wiped whenever Binary Ninja auto-updates. You can locate it with `Open Plugin Folder` in the command palette and navigate "up" a directory.
49+
Always place your signature libraries in your user directory. The installation path is wiped whenever Binary Ninja
50+
auto-updates. You can locate it with `Open Plugin Folder` in the command palette and navigate "up" a directory.
5051

5152
### Manually
5253

53-
Aside from using the signature directory you can load any WARP file manually using the
54-
command `WARP\\Load File` or via the UI sidebar, they both do the same thing. Once the file is
55-
loaded, you do not need to load if for every view, it is available globally.
54+
Aside from using the signature directory you can load any WARP file manually using the command `WARP\\Load File` or via
55+
the UI sidebar, they both do the same thing. Once the file is loaded, you do not need to load it for every view, it is
56+
available globally.
5657

5758
???+ Info "Tip"
5859
When loading signatures you may encounter a dialog asking to "Override file target?" this happens when your file
@@ -114,9 +115,10 @@ make the files load quicker, turn off compression.
114115

115116
## Networked Functionality
116117

117-
WARP for Binary Ninja provides the ability to lazily pull data (functions, types) from a WARP server, by default, networked
118-
functionality is disabled, as it requires sending the functions platform (`windows-x86`) and GUID (`2f893a32-8592-54e2-8052-207603976686`)
119-
which can be considered sensitive information, see [Connecting](#connecting) to learn how to enable this functionality.
118+
WARP for Binary Ninja provides the ability to lazily pull data (functions, types) from a WARP server. By default,
119+
networked functionality is disabled since it requires sending the functions platform (`windows-x86`) and GUID
120+
(`2f893a32-8592-54e2-8052-207603976686`) which can be considered sensitive information. See [Connecting](#connecting) to
121+
learn how to enable this functionality.
120122

121123
### Connecting
122124

@@ -228,7 +230,7 @@ The function GUID will differ if the instruction highlights are not exactly the
228230

229231
When running the matcher manually, you may get a warning about no relocatable regions found; this means you have no defined
230232
sections or segments in your view. For WARP to work we must have some range of address space to work with, without it the
231-
function GUID's will likely be inconsistent if the functions can be based at different addresses.
233+
function GUIDs will likely be inconsistent if the functions can be based at different addresses.
232234

233235
### Failed to connect to the server
234236

0 commit comments

Comments
 (0)