summaryrefslogtreecommitdiff
path: root/xmlhelp/source/com/sun/star/help/HelpIndexer.java
diff options
context:
space:
mode:
Diffstat (limited to 'xmlhelp/source/com/sun/star/help/HelpIndexer.java')
-rw-r--r--xmlhelp/source/com/sun/star/help/HelpIndexer.java8
1 files changed, 8 insertions, 0 deletions
diff --git a/xmlhelp/source/com/sun/star/help/HelpIndexer.java b/xmlhelp/source/com/sun/star/help/HelpIndexer.java
index bd09982daa3e..abb866804b43 100644
--- a/xmlhelp/source/com/sun/star/help/HelpIndexer.java
+++ b/xmlhelp/source/com/sun/star/help/HelpIndexer.java
@@ -40,6 +40,14 @@ import java.io.IOException;
import java.util.Date;
import java.util.zip.ZipOutputStream;
+/**
+ When this tool is used with long path names on Windows, that is paths which start
+ with \\?\, then the caller must make sure that the path is unique. This is achieved
+ by removing '.' and '..' from the path. Paths which are created by
+ osl_getSystemPathFromFileURL fulfill this requirement. This is necessary because
+ lucene is patched to not use File.getCanonicalPath. See long_path.patch in the lucene
+ module.
+ */
public class HelpIndexer extends WeakBase
implements XServiceInfo, XInvocation
{