diff src/org/tmatesoft/hg/internal/StoragePathHelper.java @ 418:528b6780a8bd

A bit of FIXME cleanup (mostly degraded to TODO post 1.0), comments and javadoc
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Thu, 22 Mar 2012 21:02:20 +0100
parents 464b4404e75d
children 48f993aa2f41
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/internal/StoragePathHelper.java	Thu Mar 22 20:14:06 2012 +0100
+++ b/src/org/tmatesoft/hg/internal/StoragePathHelper.java	Thu Mar 22 21:02:20 2012 +0100
@@ -61,9 +61,10 @@
 		charEncodingBuf = CharBuffer.allocate(1);
 	}
 
-	// FIXME document what path argument is, whether it includes .i or .d, and whether it's 'normalized' (slashes) or not.
-	// since .hg/store keeps both .i files and files without extension (e.g. fncache), guees, for data == false 
-	// we shall assume path has extension
+	/**
+	 * path argument is repository-relative name of the user's file.
+	 * It has to be normalized (slashes) and shall not include extension .i or .d.
+	 */
 	public CharSequence rewrite(CharSequence p) {
 		final String STR_STORE = "store/";
 		final String STR_DATA = "data/";