[jira] [Created] (FLINK-12491) Incorrect documentation for directory path separators of CoreOptions.TMP_DIRS

[Shang Yuanchun (Jira)]

Kezhu Wang created FLINK-12491:
----------------------------------

             Summary: Incorrect documentation for directory path separators of CoreOptions.TMP_DIRS
                 Key: FLINK-12491
                 URL: https://issues.apache.org/jira/browse/FLINK-12491
             Project: Flink
          Issue Type: Improvement
          Components: Runtime / Configuration
    Affects Versions: 1.8.0, 1.7.2, 1.6.4, 1.9.0
            Reporter: Kezhu Wang
            Assignee: Kezhu Wang


{{CoreOptions.TMP_DIRS}} and {{ConfigConstants.TASK_MANAGER_TMP_DIR_KEY}} both say that:

{quote}
The config parameter defining the directories for temporary files, separated by
         * ",", "|", or the system's \{@link java.io.File#pathSeparator}.
{quote}

But the parsing phase uses {{String.split}} with argument {{",|" + File.pathSeparator}} eventually. However, in fact the sole parameter of {{String.split}} is a regular expression, so the directory path separators are "," or {{java.io.File#pathSeparator}}. After digging into history, I found that the documentation was introduced in commit {{a7c407ace4f6cbfbde3e247071cee5a755ae66db}} and inherited by {{76abcaa55d0d6ab704b7ab8164718e8e2dcae2c4}}. So, I think it is safe to drop "|" from documentation.


{code:title=ConfigurationUtils.java}
public class ConfigurationUtils {
        private static String[] splitPaths(@Nonnull String separatedPaths) {
                return separatedPaths.length() > 0 ? separatedPaths.split(",|" + File.pathSeparator) : EMPTY;
}
{code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)