From a5ecae29cc50fd7191189927d4df2a340b1f009f Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Thu, 16 Jul 2020 23:21:55 +0100 Subject: [PATCH] Configuration: Improve the VersionableInterface documentation --- volatility/framework/interfaces/configuration.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/volatility/framework/interfaces/configuration.py b/volatility/framework/interfaces/configuration.py index 51ad47085..6ada095c2 100644 --- a/volatility/framework/interfaces/configuration.py +++ b/volatility/framework/interfaces/configuration.py @@ -690,12 +690,17 @@ class ConfigurableInterface(metaclass = ABCMeta): class VersionableInterface: + """A class that allows version checking so that plugins can request specific versions of components they made need + + This currently includes other Plugins and scanners, but may be extended in the future + + All version number should use semantic versioning + """ _version: Tuple[int, int, int] = (0, 0, 0) @classproperty def version(cls) -> Tuple[int, int, int]: - """The version of the current interface (classmethods available on the - plugin). + """The version of the current interface (classmethods available on the component). It is strongly recommended that Semantic Versioning be used (and the default version verification is defined that way):