Improve documentation for __init__ files.

This commit is contained in:
Mike Auty
2018-12-16 14:06:47 +00:00
parent 7818fba4a4
commit 4bf995059b
5 changed files with 38 additions and 4 deletions
+6
View File
@@ -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
+8 -1
View File
@@ -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
+8 -1
View File
@@ -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
+8 -1
View File
@@ -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
@@ -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