You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2018/06/16 06:57:16 UTC
ant-ivyde git commit: Update dev instructions
Repository: ant-ivyde
Updated Branches:
refs/heads/master 3a0b7781d -> 2505d3b1b
Update dev instructions
Project: http://git-wip-us.apache.org/repos/asf/ant-ivyde/repo
Commit: http://git-wip-us.apache.org/repos/asf/ant-ivyde/commit/2505d3b1
Tree: http://git-wip-us.apache.org/repos/asf/ant-ivyde/tree/2505d3b1
Diff: http://git-wip-us.apache.org/repos/asf/ant-ivyde/diff/2505d3b1
Branch: refs/heads/master
Commit: 2505d3b1b982c0cade9488237675f97c1843e049
Parents: 3a0b778
Author: Gintas Grigelionis <gi...@apache.org>
Authored: Sat Jun 16 08:57:04 2018 +0200
Committer: Gintas Grigelionis <gi...@apache.org>
Committed: Sat Jun 16 08:57:04 2018 +0200
----------------------------------------------------------------------
doc/src/dev/build.adoc | 22 +++++++++++-----------
doc/src/dev/dev-env-setup.adoc | 24 ++++++++++++------------
doc/src/dev/updatesite.adoc | 20 ++++++++++----------
3 files changed, 33 insertions(+), 33 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/2505d3b1/doc/src/dev/build.adoc
----------------------------------------------------------------------
diff --git a/doc/src/dev/build.adoc b/doc/src/dev/build.adoc
index 95052fb..00be96e 100644
--- a/doc/src/dev/build.adoc
+++ b/doc/src/dev/build.adoc
@@ -23,42 +23,42 @@ This page describes how to build the Apache IvyDE plugin from the source. The bu
=== [[eclipse-install]]Eclipse installation
-You need first an Eclipse install which contains the PDE plugins (by default included in the "SDK" and "Classic" versions). We will refer to the Eclipse installation path in the documentation as `$ECLIPSE_HOME`. In that `$ECLIPSE_HOME` folder you should have the plugins and features folders.
+First, you need an Eclipse installation which contains the PDE plugins (e.g., an Eclipse SDK). We will refer to the Eclipse installation path in the documentation as `$ECLIPSE_HOME`. In that `$ECLIPSE_HOME` folder you should have the `plugins` and `features` folders.
It is recommended to have an Eclipse installation dedicated to the build. So you will be able to have better control over the Ivy bundle installed there. And as the build cleans the internal cache of Eclipse, running an Eclipse and building with the same instance might cause some troubleshooting in the IDE.
-Lots of ant target depends on that Eclipse installation, so they need a `baseLocation` property to be defined. Note that you can avoid specifying that property in each command line by having a `local.build.properties` file which contains something like:
+Lots of Ant targets depends on that Eclipse installation, so they need a `baseLocation` property to be defined. Note that you can avoid specifying that property in each command line by having a `local.build.properties` file which contains something like:
[source]
----
baseLocation=/home/me/tools/eclipse-4.3
----
-An Ant target is provided to download all the necessary binaries, just like the CI is running: `ant download-eclipse`. No need to specify a `baseLocation` in the prperty file to use that downloaded Eclipse and plugins.
+An Ant target is provided to download all the necessary binaries, just like the CI is running: `ant download-eclipse`. No need to specify a `baseLocation` in the property file to use that downloaded Eclipse and plugins.
=== [[install-ivy]]The Apache Ivy bundle
-The IvyDE plugins depends on the Apache Ivy 2.0 OSGi bundle. So the Ivy bundle have to be installed in the Eclipse installation before starting the build. An Ant target will accomplished that task quite automatically. Inline help will be displayed when no property is specified:
+The IvyDE plugins depends on the Apache Ivy 2.0 OSGi bundle. So the Ivy bundle has to be installed in the Eclipse installation before starting the build. An Ant target will accomplish that automatically. Inline help will be displayed when no property is specified:
[source]
----
ant install-ivy
----
-Note: due to link:https://issues.apache.org/jira/browse/IVY-802[an old bug in the build script of Ivy], the OSGi version of Ivy is "0.0.0" for every version older than the 2.0.0-RC1. So older version than 2.0.0-RC1 is not supported.
+Note: due to link:https://issues.apache.org/jira/browse/IVY-802[an old bug in the build script of Ivy], the OSGi version of Ivy is "0.0.0" for every version older than the 2.0.0-RC1. So versions older than 2.0.0-RC1 are not supported.
== [[build]]Building
-First somehow you got some sources, for instance from the ASF git repository:
+First somehow you get the source code, for instance from the ASF Git repository:
[source]
----
git clone http://git.apache.org/ant-ivyde.git ivyde
----
-or get directly the released sources from the link:../../download.cgi#sources[distribution].
+or use the released source code directly from the link:../../download.cgi#sources[distribution].
-And go into the root folder of the sources. In that folder you should see the builder, org.apache.ivyde.eclipse and org.apache.ivyde.feature folders.
+Then, go into the root directory of the sources. In that directory you should see the `builder`, `org.apache.ivyde.eclipse` and `org.apache.ivyde.feature` subdirectories.
And run the build:
@@ -67,15 +67,15 @@ And run the build:
ant build -DbaseLocation=$ECLIPSE_HOME
----
-Then in the created directory "work" you will find a directory (something like 2.0.0.alpha1-200804171513) in which you will find the zip archive ready to be unzipped in an Eclipse install.
+Then in the created directory `work` you will find a subdirectory (something like `2.0.0.alpha1-200804171513`) in which you will find the zip archive ready to be unzipped in an Eclipse install.
== [[install]]Install
-After a successful build you should have a zip file at `dist/org.apache.ivyde.feature-$VERSION.zip`. The zip file contains the "plugins" and "features" folders ready to be unzipped in an Eclipse install. So here is the process:
+After a successful build you should have a zip file at `dist/org.apache.ivyde.feature-$VERSION.zip`. The zip file contains the `plugins` and `features` directories ready to be unzipped in an Eclipse install. So here is the process:
[source]
----
-cd $ECLIPSE_HOME
+cd $ECLIPSE_HOME/dropins
unzip ...../dist/org.apache.ivyde.feature-$VERSION.zip
----
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/2505d3b1/doc/src/dev/dev-env-setup.adoc
----------------------------------------------------------------------
diff --git a/doc/src/dev/dev-env-setup.adoc b/doc/src/dev/dev-env-setup.adoc
index 68fca9d..c12130b 100644
--- a/doc/src/dev/dev-env-setup.adoc
+++ b/doc/src/dev/dev-env-setup.adoc
@@ -30,15 +30,15 @@ You need some plugins installed in your Eclipse:
If you have a "Classic" Eclipse, the PDE plugins are already installed. Otherwise you should find them in the Eclipse update site "The Eclipse Project Updates". Under the section "Eclipse Platform SDK", the feature to install is called "Eclipse Platform SDK".
-The Zest plugins can be found in the Eclipse updatesite of your Eclipse distribution (Indigo, Juno, etc...). Under the section "Modeling", the feature to install is called "Graphical Editing Framework Zest Visualization Toolkit SDK".
+The Zest plugins can be found in the Eclipse update site of your Eclipse distribution (Indigo, Juno, etc...). Under the section "Modeling", the feature to install is called "Graphical Editing Framework Zest Visualization Toolkit SDK".
=== Ivy
-You will also need Ivy as it is a dependency of IvyDE. Either you will work against a release version of Ivy, or work against an- build form the source in your Eclipse. Note that even when working against a released version, you will still be able to run in debug mode, see the sources and put break points in Ivy code. You just won't be able to modify the sources.
+You will also need Ivy as it is a dependency of IvyDE. Either you will work against a release version of Ivy, or work against a build from the source in your Eclipse. Note that even when working against a released version, you will still be able to run in debug mode, see the sources and put break points in Ivy code. You just won't be able to modify the sources.
-Running against a released version is the simpler. Just install it from the IvyDE updatesite in you Eclipse.
+Running against a released version is the simpler case. Just install it from the IvyDE update site in your Eclipse.
-Otherwise you will need to setup a project for Ivy in your workspace, see next section.
+Otherwise you will need to set up a project for Ivy in your workspace, see next section.
== Setup
@@ -46,7 +46,7 @@ Otherwise you will need to setup a project for Ivy in your workspace, see next s
If you want to run against an Ivy from source in your workspace, you must import the Ivy project in your workspace. Otherwise, you can skip this section.
-The Ivy sources already contains the Eclipse metadata. Just "Import" from "Existing Project into Workspace".
+The Ivy sources already contain the Eclipse metadata. Just "Import" from "Existing Project into Workspace".
=== Import IvyDE
@@ -57,29 +57,29 @@ If you intend to work on the resolve visualizer, you should import the plugin "o
== Launch
-You will have to create you "Launch configuration".
+You will have to create your "Launch configuration".
* In the Debug menu, select "Debug Configuration...".
-* On the section "Eclipse Application", right click and select "New".
+* Right click the section "Eclipse Application" and select "New".
* Give a better name to your configuration: "IvyDE".
-* You may want to give a better location to the workspace in which the forked eclipse will run: for instance "${workspace_loc}/_eclipse/runtime-IvyDE"
+* You may want to give a better location to the workspace in which the forked Eclipse will run: for instance "${workspace_loc}/_eclipse/runtime-IvyDE"
-Now you can launch and so some happy debugging !
+Now you can launch and have some happy debugging !
=== Advanced tips
==== Console log
-For old version of Eclipse only, in recent ones the option is automatically added.
+For old version of Eclipse only, in recent ones the option is added automatically.
-By default the logs of the forked Eclipse just goes in the Error log of the forked Eclipse. It is not ideal when browsing a stack trace since you will have to switch between the 2 Eclipse.
+By default the logs of the forked Eclipse just goes in the Error log of the forked Eclipse. It is not ideal when browsing a stack trace since you will have to switch between the two Eclipse instances.
Just add "-consoleLog" in the "Program Arguments" of the launch configuration so that errors of the forked Eclipse will go in the console of the host one.
==== Slow fork
Your hosting Eclipse may have a lot of plugins installed. By default, forking an Eclipse will launch with the same plugins. So forking may take some time and can be painful while developing.
-In the launch configuration, you can tune what plugins should be loaded in the "Plug-ins" tab. Select "plug-ins selected below only". Then it is quite tedious to know which one should be selected. The button "Add Required Plug-ins" will help you not missing one.
+In the launch configuration, you can tune what plugins should be loaded in the "Plug-ins" tab. Select "plug-ins selected below only". Then it is quite tedious to know which one should be selected. The button "Add Required Plug-ins" will help you not to miss one.
Basically you will need:
* org.eclipse.ivyde (in your workspace)
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/2505d3b1/doc/src/dev/updatesite.adoc
----------------------------------------------------------------------
diff --git a/doc/src/dev/updatesite.adoc b/doc/src/dev/updatesite.adoc
index d1c5005..48dadb3 100644
--- a/doc/src/dev/updatesite.adoc
+++ b/doc/src/dev/updatesite.adoc
@@ -17,11 +17,11 @@
under the License.
////
-Once a release have been build for Ivy or IvyDE, they should be pushed to the Eclipse updatesite so that Eclipse users will be able to update automatically their installed version of Ivy or IvyDE.
+Once a release has been build for Ivy or IvyDE, it should be pushed to the Eclipse updatesite so that Eclipse users will be able to update automatically their installed version of Ivy or IvyDE.
This doc is in two parts, the link:#setup[setup] of the updatesite which will be the candidate for the vote of the Ivy or IvyDE release, and the link:#deployment[final deployment] once the release is accepted.
-Important note: in this doc, the released version is denoted as $VERSION (and have to be replaced accordingly in every commands), but this is the OSGi one, not the usually shown one, in particular for release candidate versions. For instance an Ivy version can be `2.0.0-RC1` but the OSGi one, and the one to use here is `2.0.0.cr1`.
+Important note: in this doc, the released version is denoted as $VERSION (and has to be replaced accordingly in every command), but this is the OSGi one, not the usually shown one, in particular for release candidate versions. For instance an Ivy version can be `2.0.0-RC1` but the OSGi one, and the one to use here is `2.0.0.cr1`.
== [[setup]]Build a p2 repository
@@ -72,7 +72,7 @@ svn rm https://dist.apache.org/repos/dist/dev/ant/ivyde/updatesite/ivyde-$VERSIO
=== Clean up old releases
-First, you may want to remove from the main repository references to the older releases. Note also that the ASF policy regarding the space occupied by the main dist is about rectricting to only have the main stable released version available there; older are archived on archiche.apache.org.
+First, you may want to remove from the main repository references to the older releases. Note also that the ASF policy regarding the space occupied by the main dist is about restricting to only have the main stable released version available there; older are archived at https://archive.apache.org/dist/ant/.
To remove a version from the main dist, you'll need to remove the data and remove its reference in the main updatesite.
@@ -83,20 +83,20 @@ To remove the data:
svn rm https://dist.apache.org/repos/dist/release/ant/ivyde/updatesite/ivyde-$OLD_VERSION -m 'Remove old version'
----
-Then the version listed in the updatesite are maintained in `https://svn.apache.org/repos/asf/ant/ivy/updatesite/trunk/versions.xml`
+Then the version listed in the updatesite is maintained in `https://svn.apache.org/repos/asf/ant/ivy/updatesite/trunk/versions.xml`
-Then you have to decide if the version you removed should be still listed in the Eclipse updatesite or not.
+You have to decide if the version you removed should be still listed in the Eclipse updatesite or not.
To remove a version from the listed one, edit the file `versions.xml`
-* If the version should no appear anymore, just delete the line about the deleted version.
+* If the version should not appear anymore, just delete the line listing the deleted version.
* If the version should still be listed, prepend the reference to the old version by `http://archive.apache.org/dist/ant/ivy/updatesite/`
-NB: adding or removing lines in `versions.xml` infer that you should edit the `size` attribute in the `versions.xml`, it should correspond to the number of "child".
+NB: adding or removing lines in `versions.xml` infer that you should edit the `size` attribute in the `versions.xml`, it should correspond to the number of "child" tags.
=== Publish the p2 repository data
-It is just about moving data (svn rm is not allowed, the two steps are required):
+It is just about moving data (`svn rm` is not allowed, the two steps are required):
[source]
----
svn mv https://dist.apache.org/repos/dist/dev/ant/ivyde/updatesite/ivyde-$VERSION https://dist.apache.org/repos/dist/release/ant/ivyde/updatesite/ -m 'publishing the p2 repo of the release of IvyDE $VERSION'
@@ -106,13 +106,13 @@ svn mv https://dist.apache.org/repos/dist/dev/ant/ivyde/updatesite/ivyde-$VERSIO
Last but not least, the p2 repository should now list the new release.
-Edit the file `versions.xml`, and add a line about the released version:
+Edit the file `versions.xml`, and add a line listing the released version:
[source]
----
<child location='ivyde-2.1.0'/>
----
-NB: adding or removing lines in `versions.xml` infer that you should edit the `size` attribute in the `versions.xml`, it should correspond to the number of "child".
+NB: adding or removing lines in `versions.xml` infer that you should edit the `size` attribute in the `versions.xml`, it should correspond to the number of "child" tags.
And run:
[source]