HACKING: add note about absolute paths

This commit is contained in:
Julian Ospald 2016-04-17 01:44:53 +02:00
parent 260e7ea01c
commit 2e16e0ae48
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28

View File

@ -28,6 +28,8 @@ should be seen as a library. This is the entry point where
and the File type in general [is constructed](./../src/HSFM/FileSystem/FileType.hs#L302). and the File type in general [is constructed](./../src/HSFM/FileSystem/FileType.hs#L302).
The File type uses a safe Path type under the hood instead of Strings, The File type uses a safe Path type under the hood instead of Strings,
utilizing the [hpath](https://github.com/hasufell/hpath) library. utilizing the [hpath](https://github.com/hasufell/hpath) library.
Note that mostly only absolute paths are allowed on type level to improve
path and thread safety.
File operations (like copy, delete etc) are defined at File operations (like copy, delete etc) are defined at
[HSFM.FileSystem.FileOperation](./../src/HSFM/FileSystem/FileOperations.hs) [HSFM.FileSystem.FileOperation](./../src/HSFM/FileSystem/FileOperations.hs)