summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-01-11 17:19:09 -0500
committerJordan Wiens <jordan@psifertex.com>2023-01-11 17:19:09 -0500
commit97089682637a24804fe5d87e9132314f8bcc5cbc (patch)
treef220f9c75f471b76f76142b420591a32ae80c572 /docs
parentd3cad28cd95fcf7a825b913681f145f50914cfff (diff)
update function properties dialog docs for inlining
Diffstat (limited to 'docs')
-rw-r--r--docs/guide/index.md4
-rw-r--r--docs/img/efp_dialog_diagram.pngbin69941 -> 115580 bytes
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/guide/index.md b/docs/guide/index.md
index b392604b..7f55d780 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -444,7 +444,7 @@ The sorting order of segments and sections can be changed by clicking on any col
The “Edit Function Properties” dialog provides the ability to easily configure some of a function’s more advanced properties. It can be opened via the context menu when a function is focused in the graph or linear views, or via the command palette. An overview of the UI is as follows:
-1. **Function prototype.** The function’s prototype. If the prototype is too long to fit inside the window, a scroll bar will appear.
+0. **Function prototype.** The function’s prototype. If the prototype is too long to fit inside the window, a scroll bar will appear.
1. **Function info.** A list of conditionally-shown tags offering information about the function. Possible tags are as follows:
- **Function architecture/platform**: The function's architecture/platform (e.g. `windows-x86_64`)
- **Analysis skipped (too large)**: Analysis was skipped for this function because it was too large ([`analysis.limits.maxFunctionSize`](settings.md#analysis.limits.maxFunctionSize))
@@ -458,7 +458,7 @@ The “Edit Function Properties” dialog provides the ability to easily configu
1. **Calling convention.** The calling convention this function uses. All calling conventions for the function’s architecture are available as choices.
1. **Stack adjustment.** How many _extra_ bytes does this function remove from the stack upon return?
1. **Has variable arguments.** Does this function accept a variable number of arguments?
-1. **Can return.** Does this function return? If not, #8 will be unavailable.
+1. **Inline during analysis.** Causes the function to be [inlined](https://api.binary.ninja/binaryninja.function-module.html#binaryninja.function.Function.inline_during_analysis) during analysis.
1. **Clobbered registers.** The list of registers that this function clobbers; individual registers can be checked or unchecked.
1. **Return registers.** The list of registers that this function returns data in; individual registers can be checked or unchecked.
1. **Register stack adjustments.** A table containing a row for each register stack (e.g. x87) in the architecture, with the ability to adjust how many registers are removed from each stack when the function returns.
diff --git a/docs/img/efp_dialog_diagram.png b/docs/img/efp_dialog_diagram.png
index 2e7e271e..0185a3a7 100644
--- a/docs/img/efp_dialog_diagram.png
+++ b/docs/img/efp_dialog_diagram.png
Binary files differ