summaryrefslogtreecommitdiff
path: root/docs/dev/annotation.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-10-18 17:35:22 -0400
committerJordan Wiens <jordan@psifertex.com>2023-10-18 17:35:22 -0400
commitbbc4bd934e60bd50c2e1a7450c2f8a79f7115a57 (patch)
treef45b927f9315f9bea5860e0442cbbde1449002dc /docs/dev/annotation.md
parent256443d0fb8fe4e8de157b716170edfda3f25205 (diff)
describe auto tags
Diffstat (limited to 'docs/dev/annotation.md')
-rw-r--r--docs/dev/annotation.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/dev/annotation.md b/docs/dev/annotation.md
index 03d676bc..bad34677 100644
--- a/docs/dev/annotation.md
+++ b/docs/dev/annotation.md
@@ -96,7 +96,9 @@ If you include an address when you call `Function.add_tag`, you'll create an add
### Auto Tags
-If you want to create auto tags, as of 3.4, these are no longer in separate APIs. Simply provide the `auto=True` flag to the above calls.
+Auto Tags are tags that are created automatically by some process or plugin. They will not be saved into the database as the assumption is that they are automatically created each time the file is to be opened. This is unlikely to be true for most use cases which is why the auto API was deprecated in favor of a unified API that defaults to `auto=false`.
+
+If you want to create auto tags as of 3.4, provide the `auto=True` flag to the above calls.
```py
>>> bv.add_tag(0xdeadbeef, "Vulnerability", "Buffer overflooooowwwww!!!", auto=True)