From f8f950df4160a74706bdf3d05d4996657dd208ef Mon Sep 17 00:00:00 2001 From: Jim Procter Date: Mon, 17 Aug 2020 16:09:26 +0100 Subject: [PATCH] JAL-3712 fix typos for rebuilding/updating getdown jars and added mention of mvn_cmd in the getdown building help. --- doc/building.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/building.md b/doc/building.md index ad19979..855f966 100644 --- a/doc/building.md +++ b/doc/building.md @@ -276,8 +276,8 @@ although without the many and compelling benefits of the `getdown` launcher. We have made significant customisations to the `getdown` launcher which you can find in `getdown/src/getdown`. -> You don't need to build this afresh as the required `gradle-core.jar` -and `gradle-launcher.jar` files are already distributed in `j11lib` and `getdown/lib` but if you want to, then +> You don't need to build this afresh as the required `getdown-core.jar` +and `getdown-launcher.jar` files are already distributed in `j11lib` and `getdown/lib` but if you want to, then you'll need a working Maven and also a Java 8 JDK. Ensure the Java 8 `javac` is forefront in your path and do > @@ -285,9 +285,9 @@ in your path and do >cd getdown/src/getdown >mvn clean package -Dgetdown.host.whitelist="jalview.org,*.jalview.org" >``` -> and you will find the required `.jar` files in `core/target/gradle-core-XXX.jar` -and `launcher/target/gradle-launcher-XXX.jar`. The `gradle-core.jar` should then be copied -to all three of the `j8lib`, `j11lib` and `getdown/lib` folders, whilst the `gradle-launcher.jar` only +> and you will find the required `.jar` files in `core/target/getdown-core-XXX.jar` +and `launcher/target/getdown-launcher-XXX.jar`. The `getdown-core.jar` should then be copied +to all three of the `j8lib`, `j11lib` and `getdown/lib` folders, whilst the `getdown-launcher.jar` only needs to be copied to `getdown/lib`. > >The `mvn` command should ideally include the `-Dgetdown.host.whitelist=*.jalview.org` setting. @@ -318,6 +318,7 @@ java -jar getdown/files/11/getdown-launcher.jar getdown/files/11/ jalview getdown, and the final argument, "`jalview`", is a getdown application id (only "`jalview`" is defined here). +The command line sequence for building and relocating the getdown artifacts can be executed as a script via `getdown/src/getdown/mvn_cmd`. Please make sure this script is kept up to date should the getdown build instructions change. ### Running tests -- 1.7.10.2