yetus-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a.@apache.org
Subject yetus git commit: YETUS-104. Update document about plugin functions.
Date Mon, 18 Jan 2016 19:29:40 GMT
Repository: yetus
Updated Branches:
  refs/heads/master 61220e9d0 -> d6481ff4e


YETUS-104. Update document about plugin functions.

Signed-off-by: Allen Wittenauer <aw@apache.org>


Project: http://git-wip-us.apache.org/repos/asf/yetus/repo
Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/d6481ff4
Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/d6481ff4
Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/d6481ff4

Branch: refs/heads/master
Commit: d6481ff4e679967c4209b05b4bff89d170660b8b
Parents: 61220e9
Author: Marco Zuehlke <mzuehlke@gmail.com>
Authored: Sun Jan 17 12:10:17 2016 +0100
Committer: Allen Wittenauer <aw@apache.org>
Committed: Mon Jan 18 11:29:32 2016 -0800

----------------------------------------------------------------------
 .../in-progress/precommit-advanced.md           | 21 ++++++++++++++------
 .../in-progress/precommit-buildtools.md         |  8 ++++++--
 2 files changed, 21 insertions(+), 8 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/yetus/blob/d6481ff4/asf-site-src/source/documentation/in-progress/precommit-advanced.md
----------------------------------------------------------------------
diff --git a/asf-site-src/source/documentation/in-progress/precommit-advanced.md b/asf-site-src/source/documentation/in-progress/precommit-advanced.md
index a864cf8..a6987b1 100644
--- a/asf-site-src/source/documentation/in-progress/precommit-advanced.md
+++ b/asf-site-src/source/documentation/in-progress/precommit-advanced.md
@@ -72,24 +72,24 @@ Similarly, there are other functions that may be defined during the test-patch
r
 
     HINT: It is recommended to make the pluginname relatively small, 10 characters at the
most.  Otherwise, the ASCII output table may be skewed.
 
-* pluginname\_initialize
-    - After argument parsing and prior to any other work, the initialize step allows a plug-in
to do any precursor work, set internal defaults, etc.
-
 * pluginname\_usage
     - executed when the help message is displayed. This is used to display the plug-in specific
options for the user.
 
 * pluginname\_parse\_args
     - executed prior to any other above functions except for pluginname\_usage. This is useful
for parsing the arguments passed from the user and setting up the execution environment.
 
+* pluginname\_initialize
+    - After argument parsing and prior to any other work, the initialize step allows a plug-in
to do any precursor work, set internal defaults, etc.
+
 * pluginname\_precheck
     - executed prior to the patch being applied but after the git repository is setup.  Returning
a fail status here will exit test-patch.
 
+* pluginname\_patchfile
+    - executed prior to the patch being applied but after the git repository is setup. This
step is intended to perform tests on the content of the patch itself.
+
 * pluginname\_precompile
     - executed prior to the compilation part of the lifecycle. This is useful for doing setup
work required by the compilation process.
 
-* pluginname\_compile
-    - executed immediately after the actual compilation. This is step is intended to be used
to verify the results and add extra checking of the compile phase and it's stdout/stderr.
-
 * pluginname\_postcompile
     - This step happens after the compile phase.
 
@@ -121,9 +121,18 @@ add_test_type <pluginname>
 + pluginname\_filefilter
     - executed while determine which files trigger which tests.  This function should use
`add_test pluginname` to add the plug-in to the test list.
 
+* pluginname\_compile
+    - executed immediately after the actual compilation. This step is intended to be used
to verify the results and add extra checking of the compile phase and it's stdout/stderr.
+
 * pluginname\_tests
     - executed after the unit tests have completed.
 
+* pluginname\_clean
+    - executed to allow the plugin to remove all files that have been generate by this plugin.
+
+* pluginname\_logfilter
+    - This functions should filter all lines relevant to this test from the logfile. It is
called in preparation for the `calcdiffs` function.
+
 * pluginname\_calcdiffs
 
     - This allows for custom log file difference calculation used to determine the before
and after views.  The default is to use the last column of a colon delimited line of output
and perform a diff.  If the plug-in does not provide enough context, this may result in error
skew. For example, if three lines in a row have "Missing period." as the error, test-patch
will not be able to determine exactly which line caused the error.  Plug-ins that have this
issue will want to use this or potentially modify the normal tool's output (e.g., checkstyle)
to provide a more accurate way to determine differences.

http://git-wip-us.apache.org/repos/asf/yetus/blob/d6481ff4/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
----------------------------------------------------------------------
diff --git a/asf-site-src/source/documentation/in-progress/precommit-buildtools.md b/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
index 84a8309..7c90e6c 100644
--- a/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
+++ b/asf-site-src/source/documentation/in-progress/precommit-buildtools.md
@@ -74,9 +74,13 @@ For example, the gradle build tool does not have a standard way to execute
check
 
     - After argument parsing and prior to any other work, the initialize step allows a plug-in
to do any precursor work, set internal defaults, etc.
 
-* pluginname\_count\_(test)\_probs
+* pluginname\_reorder\_modules
 
-    - Certain language test plug-ins require assistance from the build tool to count problems
in the compile log due to some tools having custom handling for those languages.  The test
plug-in name should be in the (test) part of the function name.
+    - This functions allows the plugin to (re-)order the modules (e.g. based on the output
of the maven dependency plugin). When called CHANGED_MODULES already contains all changed
modules. It must be altered to have an effect.
+
+* pluginname\_(test)\_logfilter
+
+    - This functions should filter all lines relevant to this test from the logfile. It is
called in preparation for the `calcdiffs` function. The test plug-in name should be in the
(test) part of the function name.
 
 * pluginname\_(test)_calcdiffs
 


Mime
View raw message