Skip to content

Commit

Permalink
Extend documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kwin committed Jul 30, 2024
1 parent f21ac96 commit 1afafc0
Showing 1 changed file with 29 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
------
Allan Ramirez
Dan Tran
Konrad Windszus
------
2010-01-09
------
Expand All @@ -29,12 +30,15 @@

Using System Properties

There are two ways to add a list of system properties to ${thisPlugin}:
%{toc|section=0|fromDepth=2}


There are different parameters which affect the system properties passed to ${thisPlugin} providers:

* systemPropertyVariables

This configuration is the replacement of the deprecated <<<systemProperties>>>. It can accept any value
from Maven's properties that can be converted <<to a String value>>.
This configuration is the replacement of the deprecated <<<systemProperties>>>. It can accept any {{{https://maven.apache.org/ref/3-LATEST/maven-model-builder/#model-interpolation}expression value}}
referencing Maven's properties that can be converted <<to a String value>> or arbitrary literals.

+---+
<project>
Expand All @@ -59,8 +63,11 @@ Using System Properties
</project>
+---+

* systemPropertiesFile

This configuration allows to add system properties through an external properties file whose path is given via this plugin parameter.

* systemProperties ( Deprecated )
* systemProperties (Deprecated)

+---+
<project>
Expand Down Expand Up @@ -130,7 +137,24 @@ Using System Properties
</systemProperties>
+---+

Special VM Properties
* Effective System Properties

The effective system properties are merged from the following sources:

[[1]] <<<systemProperties>>>

[[2]] <<<systemPropertiesFile>>>

[[3]] <<<systemPropertyVariables>>>

[[4]] {{{https://maven.apache.org/ref/3-LATEST/maven-core/apidocs/org/apache/maven/execution/MavenSession.html#getUserProperties()}User properties from the current Maven session}} (if <<<promoteUserPropertiesToSystemProperties>>> is not set to <<<false>>>)

[]

where latter items may overwrite properties with the same name of former items.


* Special VM Properties

Some system properties must be set on the command line of the forked VM, and cannot be set after the
VM has been started. These properties must be added to the <<<argLine>>> parameter of the Surefire plugin. E.g.,
Expand Down

0 comments on commit 1afafc0

Please sign in to comment.