summaryrefslogtreecommitdiffstats
path: root/src/lib/Bcfg2/Server/Plugins/Cfg/CfgDiffFilter.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/Bcfg2/Server/Plugins/Cfg/CfgDiffFilter.py')
-rw-r--r--src/lib/Bcfg2/Server/Plugins/Cfg/CfgDiffFilter.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgDiffFilter.py b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgDiffFilter.py
index 579fd4005..409d2cbf6 100644
--- a/src/lib/Bcfg2/Server/Plugins/Cfg/CfgDiffFilter.py
+++ b/src/lib/Bcfg2/Server/Plugins/Cfg/CfgDiffFilter.py
@@ -1,3 +1,5 @@
+""" Handle .diff files, which apply diffs to plaintext files """
+
import os
import logging
import tempfile
@@ -8,7 +10,13 @@ from Bcfg2.Server.Plugins.Cfg import CfgFilter
logger = logging.getLogger(__name__)
class CfgDiffFilter(CfgFilter):
+ """ CfgDiffFilter applies diffs to plaintext
+ :ref:`server-plugins-generators-Cfg` files """
+
+ #: Handle .diff files
__extensions__ = ['diff']
+
+ #: .diff files are deprecated
deprecated = True
def modify_data(self, entry, metadata, data):
@@ -26,3 +34,4 @@ class CfgDiffFilter(CfgFilter):
logger.error("Error applying diff %s: %s" % (delta.name, stderr))
raise Bcfg2.Server.Plugin.PluginExecutionError('delta', delta)
return output
+ modify_data.__doc__ = CfgFilter.modify_data.__doc__