Document need to clone its-base for buck-based build Change-Id: Id6c130f39c24bc016349a3f6cd190656c6bd1535
diff --git a/src/main/resources/Documentation/build.md b/src/main/resources/Documentation/build.md index 5e696e9..c537f5f 100644 --- a/src/main/resources/Documentation/build.md +++ b/src/main/resources/Documentation/build.md
@@ -1,19 +1,24 @@ Build ===== -This plugin is built with Buck. +This @PLUGIN@ plugin is built with Buck. -Clone or link this plugin to the plugins directory of Gerrit's source -tree, and issue the command: +Clone (or link) both this plugin and also +[plugins/its-base](https://gerrit-review.googlesource.com/#/admin/projects/plugins/its-base) +to the `plugins` directory of Gerrit's source tree. + +Then issue ``` - buck build plugins/its-bugzilla + buck build plugins/@PLUGIN@ ``` +in the root of Gerrit's source tree to build + The output is created in ``` - buck-out/gen/plugins/its-bugzilla/its-bugzilla.jar + buck-out/gen/plugins/@PLUGIN@/@PLUGIN@.jar ``` This project can be imported into the Eclipse IDE: @@ -25,11 +30,12 @@ To execute the tests run: ``` - buck test --all --include its-bugzilla + buck test --all --include @PLUGIN@ ``` -Note that for compatibility reasons a Maven build is provided, but is considered -to be deprecated and will be removed in a future version of this plugin. +Note that for compatibility reasons a Maven build is provided, but is +considered to be deprecated and will be removed in a future version of +this plugin. To build with Maven, change directory to the plugin folder and issue the command: