Skip to content

Commit 2dcea6b

Browse files
slawekjaranowskislawekjaranowski
authored
Document a requirements for plexus compilers (#329)
* Document a requirements for plexus compilers * AspectJ and JDK 17+
1 parent 4bc179f commit 2dcea6b

File tree

15 files changed

+124
-74
lines changed

15 files changed

+124
-74
lines changed

‎plexus-compiler-api/src/site/site.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
66
<body>
77
<menu name="Overview">
8-
<item name="Introduction" href="index.html"/>
9-
<item name="JavaDocs" href="apidocs/index.html"/>
10-
<item name="Source Xref" href="xref/index.html"/>
8+
<item name="Introduction" href="index.html" />
9+
<item name="JavaDocs" href="apidocs/index.html" />
10+
<item name="Source Xref" href="xref/index.html" />
1111
<!--item name="FAQ" href="faq.html"/-->
1212
</menu>
1313

14-
<menu ref="parent"/>
15-
<menu ref="reports"/>
14+
<menu ref="parent" />
15+
<menu ref="reports" />
1616
</body>
17-
</project>
17+
</project>

‎plexus-compiler-manager/src/site/site.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
66
<body>
77
<menu name="Overview">
8-
<item name="Introduction" href="index.html"/>
9-
<item name="JavaDocs" href="apidocs/index.html"/>
10-
<item name="Source Xref" href="xref/index.html"/>
8+
<item name="Introduction" href="index.html" />
9+
<item name="JavaDocs" href="apidocs/index.html" />
10+
<item name="Source Xref" href="xref/index.html" />
1111
<!--item name="FAQ" href="faq.html"/-->
1212
</menu>
1313

14-
<menu ref="parent"/>
15-
<menu ref="reports"/>
14+
<menu ref="parent" />
15+
<menu ref="reports" />
1616
</body>
17-
</project>
17+
</project>

‎plexus-compiler-test/src/site/site.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
66
<body>
77
<menu name="Overview">
8-
<item name="Introduction" href="index.html"/>
9-
<item name="JavaDocs" href="apidocs/index.html"/>
10-
<item name="Source Xref" href="xref/index.html"/>
8+
<item name="Introduction" href="index.html" />
9+
<item name="JavaDocs" href="apidocs/index.html" />
10+
<item name="Source Xref" href="xref/index.html" />
1111
<!--item name="FAQ" href="faq.html"/-->
1212
</menu>
1313

14-
<menu ref="parent"/>
15-
<menu ref="reports"/>
14+
<menu ref="parent" />
15+
<menu ref="reports" />
1616
</body>
17-
</project>
17+
</project>

‎plexus-compilers/plexus-compiler-aspectj/src/site/markdown/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Plexus AspectJ Compiler
2+
-----------------------
3+
4+
AspectJ Compiler support for Plexus Compiler component.
5+
6+
**Requires** `JDK 17+` and `Maven 3.9.6+`

‎plexus-compilers/plexus-compiler-aspectj/src/site/site.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
66
<body>
77
<menu name="Overview">
8-
<item name="Introduction" href="index.html"/>
9-
<item name="JavaDocs" href="apidocs/index.html"/>
10-
<item name="Source Xref" href="xref/index.html"/>
8+
<item name="Introduction" href="index.html" />
9+
<item name="JavaDocs" href="apidocs/index.html" />
10+
<item name="Source Xref" href="xref/index.html" />
1111
<!--item name="FAQ" href="faq.html"/-->
1212
</menu>
1313

14-
<menu ref="parent"/>
15-
<menu ref="reports"/>
14+
<menu ref="parent" />
15+
<menu ref="reports" />
1616
</body>
17-
</project>
17+
</project>

‎plexus-compilers/plexus-compiler-csharp/src/site/markdown/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Plexus C# Compiler
2+
------------------
3+
4+
C# Compiler support for Plexus Compiler component.
5+
6+
**Requires** `JDK 8+`

‎plexus-compilers/plexus-compiler-csharp/src/site/site.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
66
<body>
77
<menu name="Overview">
8-
<item name="Introduction" href="index.html"/>
9-
<item name="JavaDocs" href="apidocs/index.html"/>
10-
<item name="Source Xref" href="xref/index.html"/>
8+
<item name="Introduction" href="index.html" />
9+
<item name="JavaDocs" href="apidocs/index.html" />
10+
<item name="Source Xref" href="xref/index.html" />
1111
<!--item name="FAQ" href="faq.html"/-->
1212
</menu>
1313

14-
<menu ref="parent"/>
15-
<menu ref="reports"/>
14+
<menu ref="parent" />
15+
<menu ref="reports" />
1616
</body>
17-
</project>
17+
</project>

‎plexus-compilers/plexus-compiler-eclipse/src/site/markdown/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Plexus Eclipse Compiler
2+
-----------------------
3+
4+
Eclipse Compiler support for Plexus Compiler component.
5+
6+
**Requires** `JDK 17+` and `Maven 3.9.6+`

‎plexus-compilers/plexus-compiler-eclipse/src/site/site.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
66
<body>
77
<menu name="Overview">
8-
<item name="Introduction" href="index.html"/>
9-
<item name="JavaDocs" href="apidocs/index.html"/>
10-
<item name="Source Xref" href="xref/index.html"/>
8+
<item name="Introduction" href="index.html" />
9+
<item name="JavaDocs" href="apidocs/index.html" />
10+
<item name="Source Xref" href="xref/index.html" />
1111
<!--item name="FAQ" href="faq.html"/-->
1212
</menu>
1313

14-
<menu ref="parent"/>
15-
<menu ref="reports"/>
14+
<menu ref="parent" />
15+
<menu ref="reports" />
1616
</body>
17-
</project>
17+
</project>

‎plexus-compilers/plexus-compiler-javac-errorprone/src/site/markdown/index.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Plexus Javac+error-prone Component
2+
----------------------------------
3+
4+
Javac Compiler support for Plexus Compiler component,
5+
with error-prone static analysis checks enabled.
6+
7+
See https://errorprone.info
8+
9+
**Requires** `JDK 11+`

‎plexus-compilers/plexus-compiler-javac-errorprone/src/site/site.xml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
6+
<body>
7+
<menu name="Overview">
8+
<item name="Introduction" href="index.html"/>
9+
<item name="JavaDocs" href="apidocs/index.html"/>
10+
<item name="Source Xref" href="xref/index.html"/>
11+
<!--item name="FAQ" href="faq.html"/-->
12+
</menu>
13+
14+
<menu ref="parent"/>
15+
<menu ref="reports"/>
16+
</body>
17+
</project>

‎plexus-compilers/plexus-compiler-javac/src/site/markdown/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Plexus Javac Component
2+
----------------------
3+
4+
Javac Compiler support for Plexus Compiler component.
5+
6+
**Requires** `JDK 8+`

‎plexus-compilers/plexus-compiler-javac/src/site/site.xml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22

3-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
4-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
3+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
66
<body>
77
<menu name="Overview">
8-
<item name="Introduction" href="index.html"/>
9-
<item name="JavaDocs" href="apidocs/index.html"/>
10-
<item name="Source Xref" href="xref/index.html"/>
8+
<item name="Introduction" href="index.html" />
9+
<item name="JavaDocs" href="apidocs/index.html" />
10+
<item name="Source Xref" href="xref/index.html" />
1111
<!--item name="FAQ" href="faq.html"/-->
1212
</menu>
1313

14-
<menu ref="parent"/>
15-
<menu ref="reports"/>
14+
<menu ref="parent" />
15+
<menu ref="reports" />
1616
</body>
17-
</project>
17+
</project>

‎src/site/apt/index.apt

+5-5
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ Plexus Compiler
3838

3939
* {{{./plexus-compilers/}<<<plexus-compilers>>>}}: different compilers
4040

41-
* {{{./plexus-compilers/plexus-compiler-aspectj/}<<<plexus-compiler-aspectj>>>}}: AspectJ compiler,
41+
* {{{./plexus-compilers/plexus-compiler-aspectj/}<<<plexus-compiler-aspectj>>>}}: AspectJ compiler, <<requires>> <<<JDK 17+>>> and <<<Maven 3.9.6+>>>
4242

43-
* {{{./plexus-compilers/plexus-compiler-csharp/}<<<plexus-compiler-csharp>>>}}: C#/Mono compiler,
43+
* {{{./plexus-compilers/plexus-compiler-csharp/}<<<plexus-compiler-csharp>>>}}: C#/Mono compiler, <<requires>> <<<JDK 8+>>>
4444

45-
* {{{./plexus-compilers/plexus-compiler-eclipse/}<<<plexus-compiler-eclipse>>>}}: Eclipse compiler,
45+
* {{{./plexus-compilers/plexus-compiler-eclipse/}<<<plexus-compiler-eclipse>>>}}: Eclipse compiler, <<requires>> <<<JDK 17+>>> and <<<Maven 3.9.6+>>>
4646

47-
* {{{./plexus-compilers/plexus-compiler-javac/}<<<plexus-compiler-javac>>>}}: javac compiler,
47+
* {{{./plexus-compilers/plexus-compiler-javac/}<<<plexus-compiler-javac>>>}}: javac compiler, <<requires>> <<<JDK 8+>>>
4848

49-
* {{{./plexus-compilers/plexus-compiler-javac-errorprone/}<<<plexus-compiler-javac-errorprone>>>}}: javac compiler with {{{https://errorprone.info}error-prone}} static analysis checks enabled,
49+
* {{{./plexus-compilers/plexus-compiler-javac-errorprone/}<<<plexus-compiler-javac-errorprone>>>}}: javac compiler with {{{https://errorprone.info}error-prone}} static analysis checks enabled, <<requires>> <<<JDK 11+>>>
5050

5151
[]
5252

‎src/site/site.xml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<?xml version="1.0" encoding="ISO-8859-1"?>
1+
<?xml version="1.0" encoding="UTF-8"?>
22
<!--
33
~ Licensed to the Apache Software Foundation (ASF) under one
44
~ or more contributor license agreements. See the NOTICE file
@@ -18,12 +18,12 @@
1818
~ under the License.
1919
-->
2020

21-
<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
22-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
23-
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
21+
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
22+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
23+
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
2424

2525
<body>
26-
<menu ref="modules"/>
27-
<menu ref="reports"/>
26+
<menu ref="modules" />
27+
<menu ref="reports" />
2828
</body>
2929
</project>

0 commit comments

Comments
 (0)