Add some useful basic hints on how to build the different spec books
@@ -10,6 +10,8 @@ Prerequisite is an installed JDK 8.
./gradlew
+If your main JDK is higher then 8 you can set it on each run by adding `-Dorg.gradle.java.home=<pathToYouJDK>`.
+
## Only run tests for a specific reference implementation
For example to run only tests for remote service admin run this command:
@@ -34,3 +36,22 @@ Update necessary versions in `cnf/central.mvn` and add local snapshots in a new
Eventually you will also need to update the .lib file of the reference impl inside `cmf/repo`.
When running a test the installed bundle versions are shown. So you can validate if the switch worked.
+
+## Building the Specs
+
+The Specs can be build in diverent Versions. Currently available are `html`, `pdf` and `zip`. The `zip` version contains the html specs.
+
+In order to build the specs one successful build need to have happened before, so the javadoc is available.
+
+After this the following tasks can be used:
+
+ ```
+./gradlew :osgi.specs:core.pdf
+./gradlew :osgi.specs:core.html
+./gradlew :osgi.specs:core.zip
+./gradlew :osgi.specs:cmpn.pdf
+./gradlew :osgi.specs:cmpn.html
+./gradlew :osgi.specs:cmpn.zip
+ ```
+
+**Note:** If the docbook build encounters an error, it usually prints out a line the main `book.xml` it currently builds. To find the real problem, run the build with `--debug` to get more detailed error messages for the specification you are working on.
\ No newline at end of file
