Project

Profile

Help

How to connect?
Download (1.84 KB) Statistics
| Branch: | Revision:

he / BUILD.md @ 00082f6f

1
# Building Saxon HE, PE, and EE
2

    
3
The Saxon family of products  is built with Gradle.
4

    
5
## Prerequisites
6

    
7
* A Java environment suitable for running Gradle.
8

    
9
## Environment variables
10

    
11
Some prerequisites for building and/or testing are outside the scope
12
of the build. Environment variables are used to configure access to
13
these items.
14

    
15
* `SAXON_LICENSE_DIR`: The directory that contains your Saxon EE license.
16
* `W3C_QT3_TEST_SUITE_DIR`: The directory that contains your local
17
  clone of the [W3C QT3 test suite repository](https://github.com/w3c/qt3tests).
18
* `W3C_XSLT30_TEST_SUITE_DIR`: The directory that contains your local
19
  clone of the W3C [XSLT 3.0 test suite repository](https://github.com/w3c/xslt30-test).
20
* `W3C_XSD_TEST_SUITE_DIR`: The directory that contains your local
21
  clone of the W3C [XSD test suite repository](https://github.com/w3c/xsdtests).
22

    
23
## Gradle properties
24

    
25
T.B.D.
26

    
27
## Running the build
28

    
29
This build uses the Gradle wrapper to ensure portability across different systems.
30

    
31
If you run the build scripts with `~/.gradlew`, you will be using the
32
version and configuration of Gradle that is known to work. (Other
33
versions may also work, but then again, they may not.)
34

    
35
These build scripts are shared across the open source HE repository,
36
the commercial EE/PE repository, and an internal repository that is
37
used for both current and future development.
38

    
39
In the open source HE repository, only the HE product can be built.
40
There are build targets for PE and EE artifacts, but they will not,
41
and are not expected to, succeed.
42

    
43
## T.B.D.
44

    
45
## Build outputs
46

    
47
All of the task outputs are written to files and directories under the
48
`build` directory. Although it shouldn’t be necessary, it is always
49
safe to completely delete the build directory before executing a task.
50
This ensures that _everything_ necessary to execute the task will be
51
rebuilt from the current sources.
(2-2/13)