HBX-2984: Create Reference Guide for Ant

ant/docs/examples/5-minute-tutorial/README.md

@@ -16,4 +16,4 @@
 To run this example:
   - Have [Apache Ant](https://ant.apache.org) installed
   - Have [H2 Sakila database](https://github.com/koentsje/sakila-h2) running
-  - Issue `ant reveng` from a command-line window 
+  - Issue `ant` from a command-line window 

ant/docs/examples/5-minute-tutorial/build.xml

@@ -13,39 +13,22 @@
   ~ See the License for the specific language governing permissions and
   ~ limitations under the License.
   -->
-<project xmlns:ivy="antlib:org.apache.ivy.ant">
+<project name="5-minute-tutorial" default="reveng">
 
-  <property name="hibernate-tools.version" value="7.0.0.CR1"/>
-  <property name="jdbc-driver.org" value="com.h2database"/>
-  <property name="jdbc-driver.module" value="h2"/>
-  <property name="jdbc-driver.version" value="2.3.232"/>
+  <!-- Include the 'hibernatetool' task definition from the file '../common/included.xml' -->
+  <include file="../common/included.xml"/>
 
-  <ivy:cachepath 
-      organisation="org.hibernate.tool" 
-      module="hibernate-tools-ant" 
-      revision="${hibernate-tools.version}"
-      pathid="hibernate-tools.path" 
-      inline="true"/>
-  <ivy:cachepath 
-      organisation="${jdbc-driver.org}" 
-      module="${jdbc-driver.module}" 
-      revision="${jdbc-driver.version}"
-      pathid="jdbc-driver.path" 
-      inline="true"/>
-
-  <path id="classpath">
-    <path refid="hibernate-tools.path"/>
-    <path refid="jdbc-driver.path"/>
-  </path>
-
-  <taskdef 
-      name="hibernatetool"
-      classname="org.hibernate.tool.ant.HibernateToolTask"
-      classpathref="classpath" />
+  <target name="clean">
+    <!-- Delete the folder 'generated-sources' if it exists -->
+    <delete dir="generated-sources"/>
+  </target>
 
-  <target name="reveng">
+  <target name="reveng" depends="clean">
+    <!-- Generation of the artefacts in folder 'generated-sources' -->
     <hibernatetool destdir="generated-sources">
+      <!-- JDBC Configuration with properties in file 'hibernate.properties' -->
       <jdbcconfiguration propertyfile="hibernate.properties" />
+      <!-- The Java file exporter -->
       <hbm2java/>
     </hibernatetool>
   </target>

ant/docs/examples/classpath/README.md

@@ -15,4 +15,4 @@
   -->
 To run this example:
   - Have [Apache Ant](https://ant.apache.org) installed
-  - Issue `ant reveng` from a command-line window 
+  - Issue `ant` from a command-line window 

ant/docs/examples/classpath/build.xml

@@ -13,37 +13,13 @@
   ~ See the License for the specific language governing permissions and
   ~ limitations under the License.
   -->
-<project xmlns:ivy="antlib:org.apache.ivy.ant">
+<project name="classpath" default="reveng">
 
-  <property name="hibernate-tools.version" value="7.0.0.CR1"/>
-  <property name="jdbc-driver.org" value="com.h2database"/>
-  <property name="jdbc-driver.module" value="h2"/>
-  <property name="jdbc-driver.version" value="2.3.232"/>
-
-  <ivy:cachepath 
-      organisation="org.hibernate.tool" 
-      module="hibernate-tools-ant" 
-      revision="${hibernate-tools.version}"
-      pathid="hibernate-tools.path" 
-      inline="true"/>
-  <ivy:cachepath 
-      organisation="${jdbc-driver.org}" 
-      module="${jdbc-driver.module}" 
-      revision="${jdbc-driver.version}"
-      pathid="jdbc-driver.path" 
-      inline="true"/>
-
-  <path id="classpath">
-    <path refid="hibernate-tools.path"/>
-    <path refid="jdbc-driver.path"/>
-  </path>
-
-  <taskdef 
-      name="hibernatetool"
-      classname="org.hibernate.tool.ant.HibernateToolTask"
-      classpathref="classpath" />
+  <!-- Include the 'hibernatetool' task definition from the file '../common/included.xml' -->
+  <include file="../common/included.xml"/>
 
   <target name="clean">
+    <!-- Delete the folder 'additional/classes if it exists -->
     <delete dir="additional/classes"/>
   </target>
 
@@ -59,8 +35,7 @@
 
   <target name="reveng" depends="compile">
     <hibernatetool destdir="generated-sources">
-      <!-- The classpath to be used by the 'hibernatetool' task
-       to look up additional classes or resources -->
+      <!-- The classpath to be used by the 'hibernatetool' task to look up additional classes or resources -->
       <classpath>
         <pathelement location="additional/classes"/>
       </classpath>

ant/docs/examples/common/included.xml

@@ -0,0 +1,46 @@
+<!--
+  ~ Copyright 2004 - 2025 Red Hat, Inc.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" basis,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<project name="common" xmlns:ivy="antlib:org.apache.ivy.ant">
+
+    <property name="hibernate-tools.version" value="7.0.0.CR1"/>
+    <property name="jdbc-driver.org" value="com.h2database"/>
+    <property name="jdbc-driver.module" value="h2"/>
+    <property name="jdbc-driver.version" value="2.3.232"/>
+
+    <ivy:cachepath
+            organisation="org.hibernate.tool"
+            module="hibernate-tools-ant"
+            revision="${hibernate-tools.version}"
+            pathid="hibernate-tools.path"
+            inline="true"/>
+    <ivy:cachepath
+            organisation="${jdbc-driver.org}"
+            module="${jdbc-driver.module}"
+            revision="${jdbc-driver.version}"
+            pathid="jdbc-driver.path"
+            inline="true"/>
+
+    <path id="classpath">
+        <path refid="hibernate-tools.path"/>
+        <path refid="jdbc-driver.path"/>
+    </path>
+
+    <taskdef
+            name="hibernatetool"
+            classname="org.hibernate.tool.ant.HibernateToolTask"
+            classpathref="classpath" />
+
+</project>