Bug 247566 [repo] p2 reverts to legacy update site when p2 repository fails to load

1 files changed, 10 insertions, 0 deletions

diff --git a/bundles/org.eclipse.equinox.p2.metadata.repository/src/org/eclipse/equinox/internal/provisional/spi/p2/metadata/repository/MetadataRepositoryFactory.java b/bundles/org.eclipse.equinox.p2.metadata.repository/src/org/eclipse/equinox/internal/provisional/spi/p2/metadata/repository/MetadataRepositoryFactory.java
index 062048ae7..f3cb0b15c 100644
--- a/bundles/org.eclipse.equinox.p2.metadata.repository/src/org/eclipse/equinox/internal/provisional/spi/p2/metadata/repository/MetadataRepositoryFactory.java
+++ b/bundles/org.eclipse.equinox.p2.metadata.repository/src/org/eclipse/equinox/internal/provisional/spi/p2/metadata/repository/MetadataRepositoryFactory.java
@@ -43,6 +43,16 @@ public abstract class MetadataRepositoryFactory {
 
 	/**
 	 * Loads a repository corresponding to the given URL.
+	 * <p>
+	 * The error code returned in the case of failure is significant. In particular an
+	 * error code of {@link ProvisionException#REPOSITORY_FAILED_READ} indicates
+	 * that the location definitely identifies a repository of this type, but an error occurred
+	 * while loading the repository. The repository manager will not attempt to load
+	 * a repository from that location using any other factory.  An error code of
+	 * {@link ProvisionException#REPOSITORY_NOT_FOUND} indicates there is no
+	 * repository of this type at the given location, and the repository manager is free
+	 * to try again with a different repository factory.
+	 * </p>
 	 * 
 	 * @param location The location of the repository to load
 	 * @param monitor a progress monitor, or <code>null</code> if progress