From 5d894138c28fd4bf2aaae786ec9efd1c53aa9a57 Mon Sep 17 00:00:00 2001 From: Clinton Alexander Date: Mon, 10 Oct 2016 13:49:03 +0100 Subject: [PATCH] Review fixes for documentation and gitignore. --- .gitignore | 1 - docs/source/creating-a-cordapp.rst | 11 ++++++----- gradle-plugins/cordformation/README.rst | 2 +- .../main/groovy/com/r3corda/plugins/Cordform.groovy | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index a7d73bdce9..cb44cab6f3 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,6 @@ tags .DS_Store *.orig *.log -*.orig # Created by .ignore support plugin (hsz.mobi) diff --git a/docs/source/creating-a-cordapp.rst b/docs/source/creating-a-cordapp.rst index f81e15cf8a..6f21e3dfb4 100644 --- a/docs/source/creating-a-cordapp.rst +++ b/docs/source/creating-a-cordapp.rst @@ -126,22 +126,23 @@ In Gradle you can depend on these by adding/modifying your build.gradle file to Gradle Plugins for Cordapps =========================== -There are several Cordapp plugins that reduce your build.gradle boilerplate and make development of Cordapps easier. +There are several Gradle plugins that reduce your build.gradle boilerplate and make development of Cordapps easier. The available plugins are in the gradle-plugins directory of the Corda repository. Building Gradle Plugins ----------------------- -To build the plugins that Cordapps require run the following from the root of the Corda project: +To install to your local Maven repository the plugins that Cordapp gradle files require, run the following from the +root of the Corda project: .. code-block:: text ./gradlew publishToMavenLocal -The plugins will now be installed to MavenLocal. +The plugins will now be installed to your local Maven repository in ~/.m2 on Unix and %HOMEPATH%\.m2 on Windows. -Installing Gradle Plugins -------------------------- +Using Gradle Plugins +-------------------- To use the plugins, if you are not already using the Cordapp template project, you must modify your build.gradle. Add the following segments to the relevant part of your build.gradle. diff --git a/gradle-plugins/cordformation/README.rst b/gradle-plugins/cordformation/README.rst index 812e3b60c5..ab9f91bd76 100644 --- a/gradle-plugins/cordformation/README.rst +++ b/gradle-plugins/cordformation/README.rst @@ -48,7 +48,7 @@ an example of this is in the template-cordapp and below is a three node example; } } -You can create more configurations by with new tasks that extend Cordform. +You can create more configurations with new tasks that extend Cordform. New nodes can be added by simply adding another node block and giving it a different name, directory and ports. When you run this task it will install the nodes to the directory specified and a script will be generated (for UNIX users only diff --git a/gradle-plugins/cordformation/src/main/groovy/com/r3corda/plugins/Cordform.groovy b/gradle-plugins/cordformation/src/main/groovy/com/r3corda/plugins/Cordform.groovy index 59914a78f9..b4f2ff7b96 100644 --- a/gradle-plugins/cordformation/src/main/groovy/com/r3corda/plugins/Cordform.groovy +++ b/gradle-plugins/cordformation/src/main/groovy/com/r3corda/plugins/Cordform.groovy @@ -30,7 +30,7 @@ class Cordform extends DefaultTask { * Set the network map node. * * @warning Ensure the node name is one of the configured nodes. - * @param nodeName The name of one the node that will host the network map. + * @param nodeName The name of the node that will host the network map. */ public void networkMap(String nodeName) { networkMapNodeName = nodeName