Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document a requirements for plexus compilers #329

Merged
merged 2 commits into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions plexus-compiler-api/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Introduction" href="index.html" />
<item name="JavaDocs" href="apidocs/index.html" />
<item name="Source Xref" href="xref/index.html" />
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
<menu ref="parent" />
<menu ref="reports" />
</body>
</project>
</project>
18 changes: 9 additions & 9 deletions plexus-compiler-manager/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Introduction" href="index.html" />
<item name="JavaDocs" href="apidocs/index.html" />
<item name="Source Xref" href="xref/index.html" />
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
<menu ref="parent" />
<menu ref="reports" />
</body>
</project>
</project>
18 changes: 9 additions & 9 deletions plexus-compiler-test/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Introduction" href="index.html" />
<item name="JavaDocs" href="apidocs/index.html" />
<item name="Source Xref" href="xref/index.html" />
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
<menu ref="parent" />
<menu ref="reports" />
</body>
</project>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Plexus AspectJ Compiler
-----------------------

AspectJ Compiler support for Plexus Compiler component.

**Requires** `JDK 17+` and `Maven 3.9.6+`
18 changes: 9 additions & 9 deletions plexus-compilers/plexus-compiler-aspectj/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Introduction" href="index.html" />
<item name="JavaDocs" href="apidocs/index.html" />
<item name="Source Xref" href="xref/index.html" />
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
<menu ref="parent" />
<menu ref="reports" />
</body>
</project>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Plexus C# Compiler
------------------

C# Compiler support for Plexus Compiler component.

**Requires** `JDK 8+`
18 changes: 9 additions & 9 deletions plexus-compilers/plexus-compiler-csharp/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Introduction" href="index.html" />
<item name="JavaDocs" href="apidocs/index.html" />
<item name="Source Xref" href="xref/index.html" />
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
<menu ref="parent" />
<menu ref="reports" />
</body>
</project>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Plexus Eclipse Compiler
-----------------------

Eclipse Compiler support for Plexus Compiler component.

**Requires** `JDK 17+` and `Maven 3.9.6+`
18 changes: 9 additions & 9 deletions plexus-compilers/plexus-compiler-eclipse/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Introduction" href="index.html" />
<item name="JavaDocs" href="apidocs/index.html" />
<item name="Source Xref" href="xref/index.html" />
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
<menu ref="parent" />
<menu ref="reports" />
</body>
</project>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Plexus Javac+error-prone Component
----------------------------------

Javac Compiler support for Plexus Compiler component,
with error-prone static analysis checks enabled.

See https://errorprone.info

**Requires** `JDK 11+`
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Plexus Javac Component
----------------------

Javac Compiler support for Plexus Compiler component.

**Requires** `JDK 8+`
18 changes: 9 additions & 9 deletions plexus-compilers/plexus-compiler-javac/src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/DECORATION/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<project xmlns="http://maven.apache.org/DECORATION/1.8.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.8.1 https://maven.apache.org/xsd/decoration-1.8.1.xsd">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="JavaDocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<item name="Introduction" href="index.html" />
<item name="JavaDocs" href="apidocs/index.html" />
<item name="Source Xref" href="xref/index.html" />
<!--item name="FAQ" href="faq.html"/-->
</menu>

<menu ref="parent"/>
<menu ref="reports"/>
<menu ref="parent" />
<menu ref="reports" />
</body>
</project>
</project>
10 changes: 5 additions & 5 deletions src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ Plexus Compiler

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

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

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

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

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

* {{{./plexus-compilers/plexus-compiler-javac-errorprone/}<<<plexus-compiler-javac-errorprone>>>}}: javac compiler with {{{https://errorprone.info}error-prone}} static analysis checks enabled,
* {{{./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+>>>

[]

Expand Down
12 changes: 6 additions & 6 deletions src/site/site.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
Expand All @@ -18,12 +18,12 @@
~ under the License.
-->

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

<body>
<menu ref="modules"/>
<menu ref="reports"/>
<menu ref="modules" />
<menu ref="reports" />
</body>
</project>