From 7d2b87de70baf1cb0b725676db0c2118c1509937 Mon Sep 17 00:00:00 2001
From: Koen Aers <koen.aers@gmail.com>
Date: Fri, 9 May 2025 14:12:13 +0200
Subject: [PATCH] HBX-2984: Create Reference Guide for Ant   - Complete the
 section for 'property' and 'propertySet' configuration

Signed-off-by: Koen Aers <koen.aers@gmail.com>
---
 ant/docs/reference-guide.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/ant/docs/reference-guide.md b/ant/docs/reference-guide.md
index b5e4b5b717..d36c53ec11 100644
--- a/ant/docs/reference-guide.md
+++ b/ant/docs/reference-guide.md
@@ -125,7 +125,36 @@ are applicable.
 
 ### 1.2.4 The `<property>` and `<propertySet>` elements
 
+It is possible to define properties to be used by the configured exporters. To do 
+this, you can use one or more `<property>` elements. As shown below, this element uses 
+the attributes with name `key` and `value`. The `name` attribute sometimes seen in other
+places for Ant build files is *not* supported.
 
+```xml
+<hibernatetool 
+        destdir="...">
+    <property key='someKey' value='someValue' />
+    ...
+</hibernatetool>
+```
+
+If you rather want to redefine already existing properties, you can use the `propertySet` 
+element. The snippet below will redefine the properties prefixed with 'foo' and replace 
+the prefix by 'bar'.
+
+```xml
+<hibernatetool 
+        destdir="...">
+    <propertySet>
+        <propertyref prefix="foo"/>
+        <mapper type="glob" from="foo*" to="bar*"/>
+    </propertySet>
+    ...
+</hibernatetool>
+```
+
+All the possibilities documented in the [Ant documentation](https://ant.apache.org/manual/Types/propertyset.html)
+for the `propertySet`element are supported.
 
 ### 1.2.5 The Configuration Elements