Skip to content

HBX-2984: Create Reference Guide for Ant #5107

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 6, 2025
Merged

HBX-2984: Create Reference Guide for Ant #5107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions ant/docs/examples/classpath/build.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,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 -->
<classpath>
<pathelement location="additional/classes"/>
</classpath>
<classpath location="additional/classes"/>
<!-- Dummy configuration, as it is needed for any 'hibernatetool' task -->
<configuration />
<!-- Custom exporter of class 'HelloExporter' to be found on the specified classpath -->
Expand Down
18 changes: 15 additions & 3 deletions ant/docs/reference-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ and nested elements.

Let's walk through the different possibilities.

#### 1.2.1 The 'destdir' Attribute
#### 1.2.1 The `destdir` Attribute

This mandatory attribute lets you control the folder where the artefacts will be generated. If the
specified folder does not exist it will be created.
Expand All @@ -90,7 +90,7 @@ specified folder does not exist it will be created.
In the snippet above the artefacts will be generated in the subfolder `path/to/generated/sources` of
the working directory.

#### 1.2.2 The 'templatepath' Attribute
#### 1.2.2 The `templatepath` Attribute

The generation of artefacts is based on FreeMarker templates. By default, the templates are
looked up on the classpath. If you want to have fine control over the artefact generation
Expand All @@ -106,10 +106,22 @@ location of those templates.
```


#### 1.2.3 The 'classpath' Element
#### 1.2.3 The `<classpath>` Element

The `<classpath>` element can be added within the `<hiberatetool>` task to specify where to look
for classes and/or resources that are used e.g. by the configured exporters.

```xml
<hibernatetool
destdir="...">
<classpath location="location/of/additional/classes"/>
...
</hibernatetool>

```

All the usual configuration possibilities for [Ant path-like structures](https://ant.apache.org/manual/using.html#path)
are applicable.

## 2. The Hibernate Tools Configurations

Expand Down