github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[#6273] Document <configurationFile/> Maven plugin property

Browse Source
This commit is contained in:
lukaseder 2017-05-25 11:12:51 +02:00
parent 0d61bb17ab
commit e20d0e2d1a
7 changed files with 330 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.10.xml
View File

@ -17727,7 +17727,7 @@ CREATE TABLE book_to_book_store (
</p>
<p>
<strong>XML configuration (standalone and Maven)</strong></strong>
<strong>XML configuration (standalone and Maven)</strong>
</p>
</html><xml><![CDATA[<configuration>
@ -17778,6 +17778,62 @@ CREATE TABLE book_to_book_store (
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>
<p>
There is no substantial difference between running the code generator with Maven or in standalone mode. Both modes use the exact same <code>&lt;configuration/&gt;</code> element. The Maven plugin configuration adds some additional boilerplate around that:
</p>
</html><xml><![CDATA[<plugin>
<!-- Specify the maven code generator plugin -->
<!-- Use org.jooq for the Open Source Edition
org.jooq.pro for commercial editions,
org.jooq.pro-java-6 for commercial editions with Java 6 support,
org.jooq.trial for the free trial edition
Note: Only the Open Source Edition is hosted on Maven Central.
Import the others manually from your distribution -->
<groupId>org.jooq</groupId>
<artifactId>jooq-codegen-maven</artifactId>
<version>{jooq-version}</version>
<executions>
<execution>
<id>jooq-codegen</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
...
</configuration>
</execution>
</executions>
</plugin>]]></xml><html>
<h3>Additional Maven-specific flags</h3>
<p>
There are, however, some additional, Maven-specific flags that can be specified with the <code>jooq-codegen-maven</code> plugin only:
</p>
</html><xml><![CDATA[<plugin>
...
<configuration>
<!-- A boolean property (or constant) can be specified here to tell the plugin not to do anything -->
<skip>${skip.jooq.generation}</skip>
<!-- Instead of providing an inline configuration here, you can specify an external XML configuration file here -->
<configurationFile>${externalfile}</configurationFile>
</configuration>
...
</plugin>]]></xml><html>
</html></content>
</section>
<section id="codegen-ant">
<title>Running the code generator with Ant</title>
<content><html>

37
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.4.xml
View File

@ -12201,6 +12201,43 @@ Finishing : Total: 4.814ms, +3.375ms
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>
<p>
There is no substantial difference between running the code generator with Maven or in standalone mode. Both modes use the exact same <code>&lt;configuration/&gt;</code> element. The Maven plugin configuration adds some additional boilerplate around that:
</p>
</html><xml><![CDATA[<plugin>
<!-- Specify the maven code generator plugin -->
<!-- Use org.jooq for the Open Source Edition
org.jooq.pro for commercial editions,
org.jooq.pro-java-6 for commercial editions with Java 6 support,
org.jooq.trial for the free trial edition
Note: Only the Open Source Edition is hosted on Maven Central.
Import the others manually from your distribution -->
<groupId>org.jooq</groupId>
<artifactId>jooq-codegen-maven</artifactId>
<version>{jooq-version}</version>
<executions>
<execution>
<id>jooq-codegen</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
...
</configuration>
</execution>
</executions>
</plugin>]]></xml><html>
</html></content>
</section>
<section id="codegen-ant">
<title>Running the code generator with Ant</title>
<content><html>

37
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.5.xml
View File

@ -12647,6 +12647,43 @@ Finishing : Total: 4.814ms, +3.375ms
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>
<p>
There is no substantial difference between running the code generator with Maven or in standalone mode. Both modes use the exact same <code>&lt;configuration/&gt;</code> element. The Maven plugin configuration adds some additional boilerplate around that:
</p>
</html><xml><![CDATA[<plugin>
<!-- Specify the maven code generator plugin -->
<!-- Use org.jooq for the Open Source Edition
org.jooq.pro for commercial editions,
org.jooq.pro-java-6 for commercial editions with Java 6 support,
org.jooq.trial for the free trial edition
Note: Only the Open Source Edition is hosted on Maven Central.
Import the others manually from your distribution -->
<groupId>org.jooq</groupId>
<artifactId>jooq-codegen-maven</artifactId>
<version>{jooq-version}</version>
<executions>
<execution>
<id>jooq-codegen</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
...
</configuration>
</execution>
</executions>
</plugin>]]></xml><html>
</html></content>
</section>
<section id="codegen-ant">
<title>Running the code generator with Ant</title>
<content><html>

37
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.6.xml
View File

@ -15200,6 +15200,43 @@ public class Book {
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>
<p>
There is no substantial difference between running the code generator with Maven or in standalone mode. Both modes use the exact same <code>&lt;configuration/&gt;</code> element. The Maven plugin configuration adds some additional boilerplate around that:
</p>
</html><xml><![CDATA[<plugin>
<!-- Specify the maven code generator plugin -->
<!-- Use org.jooq for the Open Source Edition
org.jooq.pro for commercial editions,
org.jooq.pro-java-6 for commercial editions with Java 6 support,
org.jooq.trial for the free trial edition
Note: Only the Open Source Edition is hosted on Maven Central.
Import the others manually from your distribution -->
<groupId>org.jooq</groupId>
<artifactId>jooq-codegen-maven</artifactId>
<version>{jooq-version}</version>
<executions>
<execution>
<id>jooq-codegen</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
...
</configuration>
</execution>
</executions>
</plugin>]]></xml><html>
</html></content>
</section>
<section id="codegen-ant">
<title>Running the code generator with Ant</title>
<content><html>

53
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.7.xml
View File

@ -15624,6 +15624,59 @@ public class Book {
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>
<p>
There is no substantial difference between running the code generator with Maven or in standalone mode. Both modes use the exact same <code>&lt;configuration/&gt;</code> element. The Maven plugin configuration adds some additional boilerplate around that:
</p>
</html><xml><![CDATA[<plugin>
<!-- Specify the maven code generator plugin -->
<!-- Use org.jooq for the Open Source Edition
org.jooq.pro for commercial editions,
org.jooq.pro-java-6 for commercial editions with Java 6 support,
org.jooq.trial for the free trial edition
Note: Only the Open Source Edition is hosted on Maven Central.
Import the others manually from your distribution -->
<groupId>org.jooq</groupId>
<artifactId>jooq-codegen-maven</artifactId>
<version>{jooq-version}</version>
<executions>
<execution>
<id>jooq-codegen</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
...
</configuration>
</execution>
</executions>
</plugin>]]></xml><html>
<h3>Additional Maven-specific flags</h3>
<p>
There are, however, some additional, Maven-specific flags that can be specified with the <code>jooq-codegen-maven</code> plugin only:
</p>
</html><xml><![CDATA[<plugin>
...
<configuration>
<!-- A boolean property (or constant) can be specified here to tell the plugin not to do anything -->
<skip>${skip.jooq.generation}</skip>
</configuration>
...
</plugin>]]></xml><html>
</html></content>
</section>
<section id="codegen-ant">
<title>Running the code generator with Ant</title>
<content><html>

53
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.8.xml
View File

@ -15897,6 +15897,59 @@ public class Book {
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>
<p>
There is no substantial difference between running the code generator with Maven or in standalone mode. Both modes use the exact same <code>&lt;configuration/&gt;</code> element. The Maven plugin configuration adds some additional boilerplate around that:
</p>
</html><xml><![CDATA[<plugin>
<!-- Specify the maven code generator plugin -->
<!-- Use org.jooq for the Open Source Edition
org.jooq.pro for commercial editions,
org.jooq.pro-java-6 for commercial editions with Java 6 support,
org.jooq.trial for the free trial edition
Note: Only the Open Source Edition is hosted on Maven Central.
Import the others manually from your distribution -->
<groupId>org.jooq</groupId>
<artifactId>jooq-codegen-maven</artifactId>
<version>{jooq-version}</version>
<executions>
<execution>
<id>jooq-codegen</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
...
</configuration>
</execution>
</executions>
</plugin>]]></xml><html>
<h3>Additional Maven-specific flags</h3>
<p>
There are, however, some additional, Maven-specific flags that can be specified with the <code>jooq-codegen-maven</code> plugin only:
</p>
</html><xml><![CDATA[<plugin>
...
<configuration>
<!-- A boolean property (or constant) can be specified here to tell the plugin not to do anything -->
<skip>${skip.jooq.generation}</skip>
</configuration>
...
</plugin>]]></xml><html>
</html></content>
</section>
<section id="codegen-ant">
<title>Running the code generator with Ant</title>
<content><html>

56
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.9.xml
View File

@ -17494,6 +17494,62 @@ public class Book {
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>
<p>
There is no substantial difference between running the code generator with Maven or in standalone mode. Both modes use the exact same <code>&lt;configuration/&gt;</code> element. The Maven plugin configuration adds some additional boilerplate around that:
</p>
</html><xml><![CDATA[<plugin>
<!-- Specify the maven code generator plugin -->
<!-- Use org.jooq for the Open Source Edition
org.jooq.pro for commercial editions,
org.jooq.pro-java-6 for commercial editions with Java 6 support,
org.jooq.trial for the free trial edition
Note: Only the Open Source Edition is hosted on Maven Central.
Import the others manually from your distribution -->
<groupId>org.jooq</groupId>
<artifactId>jooq-codegen-maven</artifactId>
<version>{jooq-version}</version>
<executions>
<execution>
<id>jooq-codegen</id>
<phase>generate-sources</phase>
<goals>
<goal>generate</goal>
</goals>
<configuration>
...
</configuration>
</execution>
</executions>
</plugin>]]></xml><html>
<h3>Additional Maven-specific flags</h3>
<p>
There are, however, some additional, Maven-specific flags that can be specified with the <code>jooq-codegen-maven</code> plugin only:
</p>
</html><xml><![CDATA[<plugin>
...
<configuration>
<!-- A boolean property (or constant) can be specified here to tell the plugin not to do anything -->
<skip>${skip.jooq.generation}</skip>
<!-- Instead of providing an inline configuration here, you can specify an external XML configuration file here -->
<configurationFile>${externalfile}</configurationFile>
</configuration>
...
</plugin>]]></xml><html>
</html></content>
</section>
<section id="codegen-ant">
<title>Running the code generator with Ant</title>
<content><html>