summaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-06-28 23:40:59 +0100
committerJordan Wiens <jordan@psifertex.com>2023-06-28 23:40:59 +0100
commit09e327e88c979de7229e8cb139f9d55a65c881fd (patch)
tree4880205be680711b7735090987fd4b11c99ffb75 /docs/dev
parente2383ff7820c4bfd2d3a395c7994083d4c37e76e (diff)
small doc changes
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/annotation.md10
-rw-r--r--docs/dev/plugins.md6
2 files changed, 11 insertions, 5 deletions
diff --git a/docs/dev/annotation.md b/docs/dev/annotation.md
index e7acc7b5..81a91424 100644
--- a/docs/dev/annotation.md
+++ b/docs/dev/annotation.md
@@ -1,16 +1,16 @@
# Applying Annotations
-This document is organized into five sections describing how to work with types in Binary Ninja:
+This document is organized into five sections describing how to work with various types of annotations in Binary Ninja using the API. Note that its [companion documentation](../guide/type.md) describes how to interact with many of the same elements via the UI.
1. [Symbols](#symbols) covers how to work with Symbols in a binary
-1. [Types](#types) is how to create and interact with types through the API
-1. [Tags](#tags) is about how to create tags and bookmarks
+1. [Types](#types) documents creating and interacting with types through the API
+1. [Tags](#tags) describes how to create tags and bookmarks
1. [Type Libraries](#type-libraries) explains how to work with Type Libraries, including multiple sources of information from which Binary Ninja can automatically source for type information from and how you can add to them
1. [Signature Libraries](#signature-library) explains how to work with the signature library which match statically compiled functions which are then matched with type libraries
## Symbols
-From an API perspective there are several helper functions, for example to rename a function:
+From an API perspective there are several helper functions available for working with Symbols. For example, to rename a function:
```py
>>> current_function.name
@@ -20,7 +20,7 @@ From an API perspective there are several helper functions, for example to renam
'newName'
```
-Other objects or variables may need a [symbol](https://api.binary.ninja/binaryninja.types.Symbol.html) created and applied:
+Other objects or variables may need a [symbol](https://api.binary.ninja/binaryninja.types.Symbol.html) created and applied (this can also be done even if not using a helper function on objects such as functions):
```py
>>> mysym = Symbol(SymbolType.FunctionSymbol, here, "myVariableName")
diff --git a/docs/dev/plugins.md b/docs/dev/plugins.md
index 3e9fab2c..a03a5cd3 100644
--- a/docs/dev/plugins.md
+++ b/docs/dev/plugins.md
@@ -353,3 +353,9 @@ Several native plugin examples exist:
- [ObjectiveNinja](https://github.com/jonpalmisc/ObjectiveNinja)
- [BinExport](https://github.com/google/binexport#binary-ninja) (Used with BinDiff)
- [Binliner](https://github.com/holmesmr/binliner)
+
+## Contributing to Official Plugins
+
+There are many many official plugins released as open source. Python ones are included in the [official plugin repository](https://github.com/vector35/official-plugins), [native architectures](https://github.com/vector35/?q=arch-&type=all&language=&sort=) are available on GitHub along with several others that are included with the default product such as the [debugger](https://github.com/Vector35/debugger), the [views](https://github.com/vector35/?q=view-&type=public&language=&sort=), [platforms](https://github.com/vector35/?q=platform&type=public&language=&sort=), and some [rust plugins](https://github.com/Vector35/binaryninja-api/tree/dev/rust/examples).
+
+The first time you contribute, you'll be asked to sign a [CLA](https://gist.github.com/psifertex/a207c2e070f4e342554dc011e920b341) automatically by [cla-assistant](https://cla-assistant.io/). Further commits after the first should not require any changes. \ No newline at end of file