on master help sign in
Remove references to path encoding

There is no specific encoding of path required, it is a contract between the user and the file system, we are just a broker in the middle.

commit585b825d784727ab27745e3aae01891ee31baf1b authorHarendra Kumar <harendra@composewell.com> dateMon 16 Nov 2020, 02:57 (6 years ago) parent0bd72c5
1 file changed+3−3
src/Streamly/Internal/FileSystem/Event/Linux.hs+3−3
src/Streamly/Internal/FileSystem/Event/Linux.hs+3−3
@@ -614,7 +614,7 @@ removeFromWatch (Watch handle wdMap) path = do
614614 return newMap
615615 else return $ Map.insert wd v newMap
616616
617−-- | Given a 'Config' and list of @paths@ (UTF-8 encoded byte arrays) start
617+-- | Given a 'Config' and list of @paths@ ("/" separated byte arrays) start
618618-- monitoring the paths for file system events. Returns a 'Watch' handle which
619619-- can then be used to read the event stream or to close the watch.
620620--
@@ -721,7 +721,7 @@ watchToStream (Watch handle wdMap) =
721721-- paths could be files or directories. When the path is a directory, only the
722722-- files and directories directly under the watched directory are monitored,
723723-- contents of subdirectories are not monitored. Monitoring starts from the
724−-- current time onwards. The paths are specified as UTF-8 encoded 'Array' of
724+-- current time onwards. The paths are specified as "/" separated 'Array' of
725725-- 'Word8'.
726726--
727727-- @
@@ -778,7 +778,7 @@ getRoot Event{..} =
778778
779779-- XXX should we use a Maybe here?
780780-- | Get the file system object path for which the event is generated, relative
781−-- to the watched root. The path is a UTF-8 encoded array of bytes.
781+-- to the watched root. The path is a "/" separated array of bytes.
782782--
783783-- /Internal/
784784--