Refer to getEntryPathLength in docs of getEntryPathBuffer

Change-Id: Icca41d80bd0791cd2d4bf03297795d161afbee70

1 files changed, 8 insertions, 1 deletions

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java
index 4cf79c0a27..2dd3c3aa14 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/treewalk/AbstractTreeIterator.java
@@ -425,7 +425,14 @@ public abstract class AbstractTreeIterator {
 		return TreeWalk.pathOf(this);
 	}
 
-	/** @return the internal buffer holding the current path. */
+	/**
+	 * Get the current entry path buffer.
+	 * <p>
+	 * Note that the returned byte[] has to be used together with
+	 * {@link #getEntryPathLength()} (only use bytes up to this length).
+	 *
+	 * @return the internal buffer holding the current path.
+	 */
 	public byte[] getEntryPathBuffer() {
 		return path;
 	}