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/03/14 06:19:05 UTC
ant-ivyde git commit: Documentation review
Repository: ant-ivyde
Updated Branches:
refs/heads/master de954c0a7 -> b52a8e436
Documentation review
Project: http://git-wip-us.apache.org/repos/asf/ant-ivyde/repo
Commit: http://git-wip-us.apache.org/repos/asf/ant-ivyde/commit/b52a8e43
Tree: http://git-wip-us.apache.org/repos/asf/ant-ivyde/tree/b52a8e43
Diff: http://git-wip-us.apache.org/repos/asf/ant-ivyde/diff/b52a8e43
Branch: refs/heads/master
Commit: b52a8e4363942435c822b130182d5eb4fb66b0e3
Parents: de954c0
Author: Gintas Grigelionis <gi...@apache.org>
Authored: Wed Mar 14 07:18:50 2018 +0100
Committer: Gintas Grigelionis <gi...@apache.org>
Committed: Wed Mar 14 07:18:50 2018 +0100
----------------------------------------------------------------------
doc/src/cpc/resolve.adoc | 2 +-
doc/src/dev/build.adoc | 4 ++--
doc/src/ivyeditor.adoc | 2 +-
doc/src/non-java.adoc | 2 +-
doc/src/preferences.adoc | 4 ++--
doc/src/security.adoc | 16 ++++++++--------
6 files changed, 15 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/b52a8e43/doc/src/cpc/resolve.adoc
----------------------------------------------------------------------
diff --git a/doc/src/cpc/resolve.adoc b/doc/src/cpc/resolve.adoc
index 8b11c9d..6663cf2 100644
--- a/doc/src/cpc/resolve.adoc
+++ b/doc/src/cpc/resolve.adoc
@@ -23,7 +23,7 @@ This command will invoke the "resolve" Ivy task and update your classpath contai
There is also a "refresh" action: this action is similar to the resolve one, but does not perform a full resolve if a report already exists in the cache. This is particularly useful if you work with Apache Ant and a command line so that you avoid two full resolves. It is also the default action performed on classpath containers when the Eclipse workspace is opened (*Windows > Preferences > Ivy*), in effect restoring the classpath container to its state prior to the last closing of the workspace if no other action is performed against the ivy.xml in the meantime.
-And there is a "reload settings" action: by default IvyDE does reload ivy settings files each time a resolve it required. But in case the ivy settings file is remote, this take make the user experience quite slow. To work around that, you can check in the link:../preferences{outfilesuffix}[preference page] the option to only load on demand, and use the "reload settings" action in the context menu.
+And there is a "reload settings" action: by default IvyDE does reload Ivy settings files each time a resolve it required. But in case the ivy settings file is remote, this take make the user experience quite slow. To work around that, you can check in the link:../preferences{outfilesuffix}[preference page] the option to only load on demand, and use the "reload settings" action in the context menu.
== Context Menu
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/b52a8e43/doc/src/dev/build.adoc
----------------------------------------------------------------------
diff --git a/doc/src/dev/build.adoc b/doc/src/dev/build.adoc
index 2e63bde..512f2c2 100644
--- a/doc/src/dev/build.adoc
+++ b/doc/src/dev/build.adoc
@@ -23,9 +23,9 @@ 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.
+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.
-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 clean the internal cache of Eclipse, running an eclipse and building with the same instance might raise some troubleshootings in the IDE.
+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 somethink like:
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/b52a8e43/doc/src/ivyeditor.adoc
----------------------------------------------------------------------
diff --git a/doc/src/ivyeditor.adoc b/doc/src/ivyeditor.adoc
index 07d56ef..78af9fa 100644
--- a/doc/src/ivyeditor.adoc
+++ b/doc/src/ivyeditor.adoc
@@ -35,7 +35,7 @@ image::images/wizard2.jpg[]
. File name: the Ivy file name (ivy.xml by default).
. Organisation: the component owner name. (your company name or the company that provides the component if you are writing an ivy.xml file for 3rd party jars). Note that this value can be set in the link:preferences{outfilesuffix}[Ivy preference page.]
. Module name: the component name.
-. Status: the status of the project. (integration by default since we have just created its ivy file. Please refer to the link:../../../history/latest-milestone/index.html[Ivy documentation for more details]).
+. Status: the status of the project. (integration by default since we have just created its Ivy file. Please refer to the link:../../../history/latest-milestone/index.html[Ivy documentation for more details]).
== [[editor]]Ivy Editor
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/b52a8e43/doc/src/non-java.adoc
----------------------------------------------------------------------
diff --git a/doc/src/non-java.adoc b/doc/src/non-java.adoc
index 0249c1e..fee8f00 100644
--- a/doc/src/non-java.adoc
+++ b/doc/src/non-java.adoc
@@ -56,7 +56,7 @@ For the sample project, let's choose "javascripts".
.Ivy file
-The ivy file which declares the dependencies to retrieve.
+The Ivy file which declares the dependencies to retrieve.
For the sample project, we will use the same one has the one which is used for the Java dependencies (it is not required).
.Retrieve pattern
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/b52a8e43/doc/src/preferences.adoc
----------------------------------------------------------------------
diff --git a/doc/src/preferences.adoc b/doc/src/preferences.adoc
index 13ae5be..121b506 100644
--- a/doc/src/preferences.adoc
+++ b/doc/src/preferences.adoc
@@ -105,11 +105,11 @@ image::images/pref_settings.jpg[]
.Reload the settings only on demand:
-By default, Apache IvyDE will parse the ivy settings file each times it is needed (each resolve, refresh, clean cache or completion in the ivy editor). For remote ivysettings this can slow the UI dramatically, so it is possible to make IvyDE keep the settings in a cache and only reload them via the context menu on the container).
+By default, Apache IvyDE will parse the Ivy settings file each times it is needed (each resolve, refresh, clean cache or completion in the Ivy editor). For remote Ivy settings this can slow the UI dramatically, so it is possible to make IvyDE keep the settings in a cache and only reload them via the context menu on the container).
.Ivy settings path:
-The path to your ivy settings file. Leave it blank to use Ivy default resolvers. See also the documentation about link:eclipsevar{outfilesuffix}[Eclipse variables].
+The path to your Ivy settings file. Leave it blank to use Ivy default resolvers. See also the documentation about link:eclipsevar{outfilesuffix}[Eclipse variables].
.Ivy user dir:
http://git-wip-us.apache.org/repos/asf/ant-ivyde/blob/b52a8e43/doc/src/security.adoc
----------------------------------------------------------------------
diff --git a/doc/src/security.adoc b/doc/src/security.adoc
index c8d3e8c..f0d0e02 100644
--- a/doc/src/security.adoc
+++ b/doc/src/security.adoc
@@ -17,17 +17,17 @@
under the License.
////
-This preference section allows you to manage credentials, which the ivy dependency manager needs to access protected repositories. The credentials are directly stored into the Eclipse Secure storage and loaded during the ivyDE-plugin's startup. This preference page allows you to manage your ivy credentials safely without the need to "publish" them in plain-text inside your build-files.
+This preference section allows you to manage credentials, which the Ivy dependency manager needs to access protected repositories. The credentials are directly stored into the Eclipse Secure storage and loaded during the IvyDE-plugin's startup. This preference page allows you to manage your Ivy credentials safely without the need to "publish" them in plain-text inside your build-files.
== [[general]]General workflow
-The ivyDE credentials extension allows you - as already mentioned - to protect your ivy credentials by using the Eclipse Secure storage. The credential entries are only maintained by the Eclipse secure storage itself: Every operation (add/edit/remove) is directly performed on the Eclipse secure storage without any intermediate caches. At the ivyDE plugin's startup, the Eclipse Secure storage is accessed (this operation requires you to insert your password if your Eclipse Secure storage is password-protected) and all the credential entries - which are related to the ivy dependency manager - are loaded and copied to the internal ivy credential manager (where ivy looks for credentials in case of protected repositories).
+The IvyDE credentials extension allows you - as already mentioned - to protect your Ivy credentials by using the Eclipse Secure storage. The credential entries are only maintained by the Eclipse secure storage itself: Every operation (add/edit/remove) is directly performed on the Eclipse secure storage without any intermediate caches. At the IvyDE plugin's startup, the Eclipse Secure storage is accessed (this operation requires you to insert your password if your Eclipse Secure storage is password-protected) and all the credential entries - which are related to the Ivy dependency manager - are loaded and copied to the internal Ivy credential manager (where Ivy looks for credentials in case of protected repositories).
-Please note that this "credential-copying" is directly done after the ivyDE plugin's startup. If your ivy-configuration files, respectively, your build-files also contain credentials pointing to the same repository (same host@realm combination as already stored in the Eclipse Secure storage), the credentials inside the Eclipse Secure storage may be overwritten due to the fact, that credentials specified within the mentioned alternative locations may be added to the internal ivy credential manager after the "credential-copying" was performed.
+Please note that this "credential-copying" is directly done after the IvyDE plugin's startup. If your Ivy settings files, respectively, your buildfiles also contain credentials pointing to the same repository (same host@realm combination as already stored in the Eclipse Secure storage), the credentials inside the Eclipse Secure storage may be overwritten due to the fact that credentials specified within the mentioned alternative locations may be added to the internal Ivy credential manager after the "credential copying" was performed.
== [[credentialsOverview]]Overview
-In this view all your credentials related to the ivy dependency manager are listed. The credentials consist of:
+In this view all your credentials related to the Ivy dependency manager are listed. The credentials consist of:
* Host: The host of your protected repository.
@@ -47,11 +47,11 @@ Click on the "Add..." button to add new credentials:
image::images/sec_add_credentials_empty.png[]
-A new dialog appears where you can insert a new credential entry. The properties "Host" and "Realm" are required because they are used to identify an artifact-repository and thus also a credential entry within the Eclipse secure storage. The property "Id" is read-only and shows you the repository's identifier (host@realm).
+A new dialog appears where you can insert a new credential entry. The properties "Host" and "Realm" are required because they are used to identify an artifact repository and thus also a credential entry within the Eclipse secure storage. The property "Id" is read-only and shows you the repository's identifier (host@realm).
image::images/sec_add_credentials_filled.png[]
-If the inserted host@realm combination is unique and not already existing, the credential entry can be saved (stored directly to the Eclipse Secure storage). Press "OK" to save, "Cancel" otherwise.
+If the inserted host@realm combination is unique and does not already exist, the credential entry can be saved (stored directly to the Eclipse Secure storage). Press "OK" to save, "Cancel" otherwise.
The added credential entry is now visible within the overview and can be edited or removed:
@@ -61,7 +61,7 @@ Adding a new credential entry having the same identifier is not permitted (as me
image::images/sec_add_credentials_duplicate.png[]
-The ivy dependency manager allows multiple repositories for the same host, but their realm has to be unique on that host:
+The Ivy dependency manager allows multiple repositories for the same host, but their realm has to be unique on that host:
image::images/sec_add_credentials_duplicate_resolved.png[]
@@ -85,4 +85,4 @@ In the credentials overview press "Remove" to delete the selected credential ent
image::images/sec_remove_credentials.png[]
-Please note that the internal ivyDE credentials manager (currently) does not permit to delete credentials once they are loaded at startup. If you delete credentials entries, the corresponding entries in the internal ivyDE credentials manager are invalidated (password and username are nulled). After Eclipse is restarted, the the internal ivyDE credentials manager is rebuild.
\ No newline at end of file
+Please note that the internal IvyDE credentials manager (currently) does not permit removal of credentials once they are loaded at startup. If you delete credentials entries, the corresponding entries in the internal IvyDE credentials manager are invalidated (password and username are nulled). After Eclipse is restarted, the the internal IvyDE credentials manager is rebuild.
\ No newline at end of file