Merge "Improve JavaDoc of IEGitOperation"

1 files changed, 5 insertions, 0 deletions

diff --git a/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java b/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java
index f932442e23..4befeaaf3a 100644
--- a/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java
+++ b/org.eclipse.egit.core/src/org/eclipse/egit/core/op/IEGitOperation.java
@@ -8,6 +8,7 @@
  *******************************************************************************/
 package org.eclipse.egit.core.op;
 
+import org.eclipse.core.resources.IResourceRuleFactory;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.jobs.ISchedulingRule;
@@ -27,6 +28,10 @@ public interface IEGitOperation {
 	/**
 	 * @return the rule needed to execute this operation.
 	 * <code>null</code> if no rule is required.
+	 * A rule is required if the operation changes resources.
+	 * It can also be useful to use a rule for reading resources to avoid
+	 * changes on the resources by other threads while the operation is running.
+	 * @see IResourceRuleFactory
 	 */
 	ISchedulingRule getSchedulingRule();
 }