diff options
Diffstat (limited to 'doc/dev')
| -rw-r--r-- | doc/dev/processor.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/dev/processor.rst b/doc/dev/processor.rst index 018d216..68de828 100644 --- a/doc/dev/processor.rst +++ b/doc/dev/processor.rst @@ -18,7 +18,7 @@ Identity The identity processor is used to "touch" files, change the mode of existing files, or add arbitrary identifiers to patchset source filenames by passing arbitrary arguments. -:Class: :any:`ProcessIdentity` +:Class: :any:`IdentityProcess` :Identifier: ``id`` :Input: Ignored. :Output: @@ -37,7 +37,7 @@ The Coccinelle processor uses Coccinelle to apply patch(es) in the SmPL (Semanti In order to use this processor, Coccinelle must be installed and ``spatch`` must be available in ``$PATH``. -:Class: :any:`ProcessCoccinelle` +:Class: :any:`CoccinelleProcess` :Identifier: ``cocci`` :Input: Coccinelle's SmPL input. :Output: The contents of the target file after being processed by Coccinelle (not the diff returned by Coccinelle). @@ -51,7 +51,7 @@ Jinja template The Jinja processor passes the input through the Jinja2 templating engine. -:Class: :any:`ProcessJinja2` +:Class: :any:`Jinja2Process` :Identifier: ``jinja`` :Input: Jinja template code. :Output: The input after being processed by Jinja. @@ -59,8 +59,8 @@ The Jinja processor passes the input through the Jinja2 templating engine. .. note:: - Template variables are generated through the :any:`get_template_vars <ProcessJinja2.get_template_vars>` method. - This method returns an empty dict by default, and is meant to be implemented by implementing a custom class that derives from ProcessJinja2 and registering it through the :ref:`configuration file <ptconfig>`. + Template variables are generated through the :any:`get_template_vars <Jinja2Process.get_template_vars>` method. + This method returns an empty dict by default, and is meant to be implemented by implementing a custom class that derives from Jinja2Process and registering it through the :ref:`configuration file <ptconfig>`. .. _process_exe: @@ -70,7 +70,7 @@ Executable The executable processor runs the input as an executable, passes the target file to its standard input, and returns its standard output. -:Class: :any:`ProcessExec` +:Class: :any:`ExecProcess` :Identifier: ``exec`` :Input: Executable script. @@ -90,7 +90,7 @@ Merge The merge processor merges the input with the target file, such that changes are combined with the target instead of replacing the target. -:Class: :any:`ProcessMerge` +:Class: :any:`MergeProcess` :Identifier: ``merge`` :Input: Content to merge. :Output: Merged changes. |