kezhuw commented on issue #8418: [FLINK-12491][docs][configuration] Fix 
incorrect javadoc for path sep…
URL: https://github.com/apache/flink/pull/8418#issuecomment-491837777
 
 
   @dawidwys After dug deeper, I found the history of used path separators:
   
   * Initially, the separator was solely ":", it was changed to 
ˋFile.pathSeparatorˋ in commit  
https://github.com/apache/flink/commit/80d6c586c495f742da6e06874e1f3b2f678d7231#diff-0637c4d13b3c0f4301a62a47bedae39e
 ( Improved compatibility with Windows )
   * Then the commit 
https://github.com/apache/flink/commit/68100e5c9414da6826ab04fc1d40f2ea6e8744c2#diff-c13f0f23fb00495ef0df245fec2bbbb2
 (Allow both comma and double-colon as path separator) change it to 
ˋ",|"+File.pathSeparatorˋ. The documentation 
https://github.com/apache/flink/commit/68100e5c9414da6826ab04fc1d40f2ea6e8744c2#diff-32da23d69ac63fdaae0193ad7de283e3
 says that:
      > (colon ':' on unix) or a comma character ','. An example would be 
/data1/tmp:/data/tmp:/data3/tmp or /data1/tmp,/data2/tmp,/data3/tmp
   * After that commit, documentation added in 
https://github.com/apache/flink/commit/a7c407ace4f6cbfbde3e247071cee5a755ae66db#diff-125ce56ea60a577549026859d5d9a4e0
 and 
https://github.com/apache/flink/commit/76abcaa55d0d6ab704b7ab8164718e8e2dcae2c4#diff-c4482d965ffc8a83e8a099e0c7f07a22
 say that ˋ|ˋ is supported also which is not true.
   
   I look at ˋflink-conf.yamlˋ in master 
(518616e9f3527b2564a640b38c80db3eb54bef37 
https://github.com/apache/flink/blob/master/flink-dist/src/main/resources/flink-conf.yaml#L153),
 it says that:
   > Add a delimited list for multiple directories, using the system directory 
delimiter (colon ':' on unix) or a comma, e.g.:   
/data1/tmp:/data2/tmp:/data3/tmp
   
   So I think it is a mistake in documentation not code.
   
   Besides the history, I think it is distractive to support more separators.
   
   What do you think ?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to