You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ag...@apache.org on 2014/03/09 20:42:11 UTC
[07/11] git commit: fixed typos and simplification of documentation
fixed typos and simplification of documentation
Project: http://git-wip-us.apache.org/repos/asf/maven-surefire/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven-surefire/commit/aff26226
Tree: http://git-wip-us.apache.org/repos/asf/maven-surefire/tree/aff26226
Diff: http://git-wip-us.apache.org/repos/asf/maven-surefire/diff/aff26226
Branch: refs/heads/master
Commit: aff2622662becd48c933531b149f20f32f877555
Parents: 1c843d6
Author: Tibor Digana <ti...@lycos.com>
Authored: Sun Mar 9 18:33:20 2014 +0100
Committer: Andreas Gudian <ag...@apache.org>
Committed: Sun Mar 9 19:46:43 2014 +0100
----------------------------------------------------------------------
.../plugin/surefire/AbstractSurefireMojo.java | 63 ++++++++++----------
.../fork-options-and-parallel-execution.apt.vm | 8 +--
2 files changed, 34 insertions(+), 37 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/aff26226/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java
----------------------------------------------------------------------
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java
index f4da5a3..730b0ad 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/AbstractSurefireMojo.java
@@ -458,7 +458,8 @@ public abstract class AbstractSurefireMojo
private boolean reuseForks;
/**
- * (JUnit 4.7 provider) Indicates that threadCount is per cpu core.
+ * (JUnit 4.7 provider) Indicates that threadCount, threadCountSuites, threadCountClasses, threadCountMethods
+ * are per cpu core.
*
* @since 2.5
*/
@@ -506,21 +507,14 @@ public abstract class AbstractSurefireMojo
protected boolean parallelOptimized;
/**
- * (JUnit 4.7 provider) The attribute thread-count-suites allows you to specify the concurrency in test suites, i.e.:
+ * (JUnit 4.7 provider) This attribute allows you to specify the concurrency in test suites, i.e.:
* <ul>
- * <li>number of threads executing JUnit test suites if <code>threadCount</code> is 0 or unspecified</li>
- * <li>In a special case <code>threadCountSuites</code> and <code>threadCount</code> are specified
- * without <code>threadCountMethods</code> for <code>parallel</code>=<code>suitesAndMethods</code>.
- * <br/>Example1: threadCount=8 and threadCountSuites=3, the number of parallel methods is varying from 5 to 7 in your tests.
- * <br/>In another special case when <code>parallel</code>=<code>all</code> and the only <code>threadCountMethods</code>
- * is unspecified, then threads from suites and classes are reused in favor of methods.
- * <br/>Example2: parallel=all, threadCount=16 , threadCountSuites=2 , threadCountClasses=5,
- * the number of parallel methods is varying from 9 to 14 in your tests.
- * </li>
- * <li>integer number which represents the weight in ratio between
- * <em>threadCountSuites</em>:<code>threadCountClasses</code>:<code>threadCountMethods</code>.
- * As an example 2 is 20% of <code>threadCount</code> if the ratio is <em>2</em>:3:5</li>
- * <li>You can impose limitation on parallel suites if <code>useUnlimitedThreads</code> is specified.</li>
+ * <li>number of concurrent suites if <code>threadCount</code> is 0 or unspecified</li>
+ * <li>limited suites concurrency if <code>useUnlimitedThreads</code> is set to <strong>true</strong></li>
+ * <li>if <code>threadCount</code> and certain thread-count parameters are > 0 for <code>parallel</code>, the
+ * concurrency is computed from ratio. For instance parallel=all and the ratio between
+ * <em>threadCountSuites</em>:<code>threadCountClasses</code>:<code>threadCountMethods</code> is
+ * <em>2</em>:3:5, there is 20% of <code>threadCount</code> in concurrent suites.</li>
* </ul>
*
* Only makes sense to use in conjunction with the <code>parallel</code> parameter.
@@ -532,21 +526,18 @@ public abstract class AbstractSurefireMojo
protected int threadCountSuites;
/**
- * (JUnit 4.7 provider) The attribute thread-count-classes allows you to specify the concurrency in test classes, i.e.:
+ * (JUnit 4.7 provider) This attribute allows you to specify the concurrency in test classes, i.e.:
* <ul>
- * <li>number of threads executing JUnit test classes if <code>threadCount</code> is 0 or unspecified</li>
- * <li>In a special case <code>threadCountClasses</code> and <code>threadCount</code> are specified
- * without <code>threadCountMethods</code> for <code>parallel</code>=<code>classesAndMethods</code>.
- * <br/>Example1: threadCount=8 and threadCountClasses=3, the number of parallel methods is varying from 5 to 7 in your tests.
- * <br/>In another special case when <code>parallel</code>=<code>all</code> and the only <code>threadCountMethods</code>
- * is unspecified, then threads from suites and classes are reused in favor of methods.
- * <br/>Example2: parallel=all, threadCount=16 , threadCountSuites=2 , threadCountClasses=5,
- * the number of parallel methods is varying from 9 to 14 in your tests.
+ * <li>number of concurrent classes if <code>threadCount</code> is 0 or unspecified</li>
+ * <li>limited classes concurrency if <code>useUnlimitedThreads</code> is set to <strong>true</strong></li>
+ * <li>if <code>threadCount</code> and certain thread-count parameters are > 0 for <code>parallel</code>, the
+ * concurrency is computed from ratio. For instance parallel=all and the ratio between
+ * <code>threadCountSuites</code>:<em>threadCountClasses</em>:<code>threadCountMethods</code> is
+ * 2:<em>3</em>:5, there is 30% of <code>threadCount</code> in concurrent classes.</li>
+ * <li>as in the previous case but without this leaf thread-count. Example: parallel=suitesAndClasses,
+ * threadCount=16, threadCountSuites=5, threadCountClasses is unspecified leaf, the number of concurrent classes
+ * is varying from >= 11 to 14 or 15. The threadCountSuites become number of threads.
* </li>
- * <li>integer number which represents the weight in ratio between
- * <code>threadCountSuites</code>:<em>threadCountClasses</em>:<code>threadCountMethods</code>.
- * As an example 3 is 30% of <code>threadCount</code> if the ratio is 2:<em>3</em>:5</li>
- * <li>You can impose limitation on parallel classes if <code>useUnlimitedThreads</code> is specified.</li>
* </ul>
*
* Only makes sense to use in conjunction with the <code>parallel</code> parameter.
@@ -558,12 +549,18 @@ public abstract class AbstractSurefireMojo
protected int threadCountClasses;
/**
- * (JUnit 4.7 provider) The attribute thread-count-methods allows you to specify the concurrency in test methods, i.e.:
+ * (JUnit 4.7 provider) This attribute allows you to specify the concurrency in test methods, i.e.:
* <ul>
- * <li>number of threads executing JUnit test methods if <code>threadCount</code> is 0 or unspecified;</li>
- * <li>integer number which represents the weight in ratio between <code>threadCountSuites</code>:<code>threadCountClasses</code>:<em>threadCountMethods</em>.
- * As an example 5 is 50% of <code>threadCount</code> if the ratio is 2:3:<em>5</em>.</li>
- * <li>You can impose limitation on parallel methods if <code>useUnlimitedThreads</code> is specified.</li>
+ * <li>number of concurrent methods if <code>threadCount</code> is 0 or unspecified</li>
+ * <li>limited concurrency of methods if <code>useUnlimitedThreads</code> is set to <strong>true</strong></li>
+ * <li>if <code>threadCount</code> and certain thread-count parameters are > 0 for <code>parallel</code>, the
+ * concurrency is computed from ratio. For instance parallel=all and the ratio between
+ * <code>threadCountSuites</code>:<code>threadCountClasses</code>:<em>threadCountMethods</em> is
+ * 2:3:<em>5</em>, there is 50% of <code>threadCount</code> in concurrent methods.</li>
+ * <li>as in the previous case but without this leaf thread-count. Example: parallel=all, threadCount=16,
+ * threadCountSuites=2, threadCountClasses=3, but threadCountMethods is unspecified leaf, the number of concurrent
+ * methods is varying from >= 11 to 14 or 15. The threadCountSuites and threadCountClasses become number of threads.
+ * </li>
* </ul>
*
* Only makes sense to use in conjunction with the <code>parallel</code> parameter.
http://git-wip-us.apache.org/repos/asf/maven-surefire/blob/aff26226/maven-surefire-plugin/src/site/apt/examples/fork-options-and-parallel-execution.apt.vm
----------------------------------------------------------------------
diff --git a/maven-surefire-plugin/src/site/apt/examples/fork-options-and-parallel-execution.apt.vm b/maven-surefire-plugin/src/site/apt/examples/fork-options-and-parallel-execution.apt.vm
index 6e9f15c..d9a6c6a 100644
--- a/maven-surefire-plugin/src/site/apt/examples/fork-options-and-parallel-execution.apt.vm
+++ b/maven-surefire-plugin/src/site/apt/examples/fork-options-and-parallel-execution.apt.vm
@@ -67,7 +67,7 @@ Fork Options and Parallel Test Execution
<<<threadCountClasses>>> or <<<threadCountMethods>>>.
If the only <<<threadCount>>> is specified, the surefire attempts to estimate
thread-counts for suites, classes and methods and reuse the threads in favor
- of parallel methods (possibly increasing concurrent methods).
+ of a leaf, e.g. parallel methods (possibly increasing concurrent methods).
As an example with unlimited number of threads, there is maximum of three
concurrent threads to execute suites:
@@ -77,8 +77,8 @@ Fork Options and Parallel Test Execution
limited:
parallel = classesAndMethods, threadCount = 8, threadCountClasses = 3.
Here the number of parallel methods is varying from 5 to 7.
- Similarily with parallel = all, but the sum of <<<threadCountSuites>>> and
- <<<threadCountClasses>>> must not excit certain <<<threadCount>>> - 1.
+ Accordingly parallel = all, but the sum of <<<threadCountSuites>>> and
+ <<<threadCountClasses>>> must not exceed certain (<<<threadCount>>> - 1).
Other combinations are possible with unspecified thread-count leaf. Make sure
that the leaf is last from the order suites-classes-methods in <<<parallel>>>.
@@ -148,7 +148,7 @@ Fork Options and Parallel Test Execution
builds, i.e. the effective value of the <<<-T>>> command line argument of
maven core.
- In case forkig is disabled (<<<forkCount=0>>>), the place holder will be
+ In case of disabled forking (<<<forkCount=0>>>), the place holder will be
replaced with <1>.
The following is an example configuration that makes use of up to three forked