From 951a0f5d508b8db4985d54751ea93ca78e57b191 Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Thu, 30 Jun 2022 11:43:38 +0100 Subject: [PATCH] Documentation: Clarify that the code is just an example Clarifies for #773 and #776 --- doc/source/simple-plugin.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/source/simple-plugin.rst b/doc/source/simple-plugin.rst index 1c7b91205..e2143f1b7 100644 --- a/doc/source/simple-plugin.rst +++ b/doc/source/simple-plugin.rst @@ -6,6 +6,12 @@ This guide will step through how to construct a simple plugin using Volatility 3 The example plugin we'll use is :py:class:`~volatility3.plugins.windows.dlllist.DllList`, which features the main traits of a normal plugin, and reuses other plugins appropriately. +.. note:: + + This document will not include the complete code necessary for a + working plugin (such as imports, etc) since it's designed to focus on the necessary componets for writing a plugin. + For complete and functioning plugins, the ``framework/plugins`` directory should be consulted. + Inherit from PluginInterface ----------------------------