WEBDIENSTE/volatility3
1
0
Fork 0
mirror of https://github.com/volatilityfoundation/volatility3.git synced 2026-09-12 12:47:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Fix requirements -> get_requirements #993

Browse Source
This commit is contained in:
Mike Auty
2023-08-03 15:16:36 +01:00
parent b050b108e4
commit 5d4c70d517
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/using-as-a-library.rst
+4 -3
View File
@@ -67,9 +67,10 @@ return a dictionary of plugin names and the plugin classes.
Determine what configuration options a plugin requires
------------------------------------------------------
For each plugin class, we can call the classmethod `requirements` on it, which will return a list of objects that
adhere to the :py:class:`~volatility3.framework.interfaces.configuration.RequirementInterface` method. The various
types of Requirement are split roughly in two,
For each plugin class, we can call the classmethod
:py:func:`~volatility3.framework.interfaces.configuration.ConfigurableInterface.get_requirements` on it, which will
return a list of objects that adhere to the :py:class:`~volatility3.framework.interfaces.configuration.RequirementInterface`
method. The various types of Requirement are split roughly in two,
:py:class:`~volatility3.framework.interfaces.configuration.SimpleTypeRequirement` (such as integers, booleans, floats
and strings) and more complex requirements (such as lists, choices, multiple requirements, translation layer
requirements or symbol table requirements). A requirement just specifies a type of data and a name, and must be