GT-2897: Renaming initialization script.

This commit is contained in:
Ryan Kurtz 2019-06-27 11:51:29 -04:00
parent b69e737a60
commit 037b5df87b
3 changed files with 16 additions and 17 deletions

View File

@ -86,10 +86,10 @@ or manually by downloading the required dependencies. Choose one of the two fol
The flat directory-style repository can be setup automatically by running a simple Gradle script.
Navigate to `~/git/ghidra` and run the following:
```
gradle --init-script gradle/init.gradle tasks
gradle --init-script gradle/fetchDependencies.gradle init
```
The Gradle task to be executed, in this case _tasks_, is unimportant. The point is to have Gradle execute
the `init.gradle` script. If it ran correctly you will have a new `~/git/ghidra/flatRepo/`
The Gradle task to be executed, in this case _init_, is unimportant. The point is to have Gradle execute
the `fetchDependencies.gradle` script. If it ran correctly you will have a new `~/git/ghidra/flatRepo/`
directory populated with the following jar files:
* AXMLPrinter2
* csframework

View File

@ -4,8 +4,8 @@ distributableGPLModule.gradle||GHIDRA||||END|
distributableGhidraExtension.gradle||GHIDRA||||END|
distributableGhidraModule.gradle||GHIDRA||||END|
externalGhidraExtension.gradle||GHIDRA||||END|
fetchDependencies.gradle||GHIDRA||||END|
helpProject.gradle||GHIDRA||||END|
init.gradle||GHIDRA||||END|
jacocoProject.gradle||GHIDRA||||END|
javaProject.gradle||GHIDRA||||END|
javaTestProject.gradle||GHIDRA||||END|

View File

@ -1,16 +1,16 @@
/*******************************************************************************
* init.gradle *
* *
* Sets up the gradle configuration for external users and downloads *
* any required dependencies that aren't available in the *
* other online repositories (eg: maven). This should be run *
* fetchDependencies.gradle *
* *
* Fetches/downloads required dependencies that aren't available in the *
* standard online repositories (eg: maven) and configures a flat *
* directory-style respository that points to them. This should be run *
* immediately after cloning the Ghidra repository before any other gradle *
* tasks are run. *
* *
* Specifically, this task: *
* *
* 1. Downloads various dependencies required by the ghidra build and *
* puts them in <ghidra repo>/ghidra/downloads/. From here they are *
* puts them in <ghidra repo>/build/downloads/. From here they are *
* unzipped and/or copied to their final locations. The files to be *
* downloaded: *
* - dex-tools-2.0.zip *
@ -20,18 +20,17 @@
* - cdt-8.6.0.zip *
* - PyDev 6.3.1.zip *
* *
* 2. Creates a gradle configuration file (repos.config) in *
* <USER_HOME>/.gradle/init.d/. This contains repository *
* information used by gradle to find dependencies (it points *
* gradle to the flatRepo location created above). *
* 2. Creates a directory at <ghidra repo>/flatRepo which is used as a *
* flat directory-style respository for the files extracted above. *
* *
* usage: from the command line in the main ghidra repository *
* directory, run the following: *
* *
* gradle --init-script gradle/init.gradle <any_task> *
* gradle --init-script gradle/fetchDependencies.gradle init *
* *
* Note: When running the script, files will only be downloaded if *
* necessary (eg: they are not already in the downloads/ folder). * *
* Note: When running the script, files will only be downloaded if *
* necessary (eg: they are not already in the build/downloads/ *
* directory). *
* *
*******************************************************************************/