From 4bf995059b1eb33c5fe1158694b9179ec115e2aa Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Sun, 16 Dec 2018 14:06:47 +0000 Subject: [PATCH] Improve documentation for __init__ files. --- volatility/plugins/__init__.py | 6 ++++++ volatility/plugins/linux/__init__.py | 9 ++++++++- volatility/plugins/mac/__init__.py | 9 ++++++++- volatility/plugins/windows/__init__.py | 9 ++++++++- volatility/plugins/windows/registry/__init__.py | 9 ++++++++- 5 files changed, 38 insertions(+), 4 deletions(-) diff --git a/volatility/plugins/__init__.py b/volatility/plugins/__init__.py index a25cb5bc9..14b3fe58c 100644 --- a/volatility/plugins/__init__.py +++ b/volatility/plugins/__init__.py @@ -2,6 +2,12 @@ This is the namespace for all volatility plugins, and determines the path for loading plugins + + NOTE: This file is important for core plugins to run (which certain components such as the windows registry layers) + are dependent upon, please DO NOT alter or remove this file unless you know the consequences of doing so. + + The framework is configured this way to allow plugin developers/users to override any plugin functionality whether + existing or new. """ from volatility.framework import constants diff --git a/volatility/plugins/linux/__init__.py b/volatility/plugins/linux/__init__.py index 1fb955e1d..3bd6d9068 100644 --- a/volatility/plugins/linux/__init__.py +++ b/volatility/plugins/linux/__init__.py @@ -1,4 +1,11 @@ -"""All Linux-related plugins""" +"""All Linux-related plugins + + NOTE: This file is important for core plugins to run (which certain components such as the windows registry layers) + are dependent upon, please DO NOT alter or remove this file unless you know the consequences of doing so. + + The framework is configured this way to allow plugin developers/users to override any plugin functionality whether + existing or new. +""" import os diff --git a/volatility/plugins/mac/__init__.py b/volatility/plugins/mac/__init__.py index 1fa00fd77..b0198a74f 100644 --- a/volatility/plugins/mac/__init__.py +++ b/volatility/plugins/mac/__init__.py @@ -1,4 +1,11 @@ -"""All Mac-related plugins""" +"""All Mac-related plugins + + NOTE: This file is important for core plugins to run (which certain components such as the windows registry layers) + are dependent upon, please DO NOT alter or remove this file unless you know the consequences of doing so. + + The framework is configured this way to allow plugin developers/users to override any plugin functionality whether + existing or new. +""" import os diff --git a/volatility/plugins/windows/__init__.py b/volatility/plugins/windows/__init__.py index 9e183090c..89502a88a 100644 --- a/volatility/plugins/windows/__init__.py +++ b/volatility/plugins/windows/__init__.py @@ -1,4 +1,11 @@ -"""All Windows OS plugins""" +"""All Windows OS plugins + + NOTE: This file is important for core plugins to run (which certain components such as the windows registry layers) + are dependent upon, please DO NOT alter or remove this file unless you know the consequences of doing so. + + The framework is configured this way to allow plugin developers/users to override any plugin functionality whether + existing or new. +""" import os diff --git a/volatility/plugins/windows/registry/__init__.py b/volatility/plugins/windows/registry/__init__.py index 2a10ee7d9..e14569096 100644 --- a/volatility/plugins/windows/registry/__init__.py +++ b/volatility/plugins/windows/registry/__init__.py @@ -1,4 +1,11 @@ -"""Windows registry plugins""" +"""Windows registry plugins + + NOTE: This file is important for core plugins to run (which certain components such as the windows registry layers) + are dependent upon, please DO NOT alter or remove this file unless you know the consequences of doing so. + + The framework is configured this way to allow plugin developers/users to override any plugin functionality whether + existing or new. +""" import os