mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

document an important property of relPathCwdToFile

Browse source
This commit is contained in:
Joey Hess 2021-05-07 12:57:54 -04:00
parent 9e1a693f16
commit 73f330a62e
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Utility/Path/AbsRel.hs
View file

@ -64,11 +64,12 @@ absPath file
#endif #endif
return $ absPathFrom cwd file return $ absPathFrom cwd file
{- Constructs a relative path from the CWD to a file. {- Constructs the minimal relative path from the CWD to a file.
- -
- For example, assuming CWD is /tmp/foo/bar: - For example, assuming CWD is /tmp/foo/bar:
- relPathCwdToFile "/tmp/foo" == ".." - relPathCwdToFile "/tmp/foo" == ".."
- relPathCwdToFile "/tmp/foo/bar" == "" - relPathCwdToFile "/tmp/foo/bar" == ""
- relPathCwdToFile "../bar/baz" == "baz"
-} -}
relPathCwdToFile :: RawFilePath -> IO RawFilePath relPathCwdToFile :: RawFilePath -> IO RawFilePath
relPathCwdToFile f = do relPathCwdToFile f = do
@ -79,7 +80,7 @@ relPathCwdToFile f = do
#endif #endif
relPathDirToFile c f relPathDirToFile c f
{- Constructs a relative path from a directory to a file. -} {- Constructs a minimal relative path from a directory to a file. -}
relPathDirToFile :: RawFilePath -> RawFilePath -> IO RawFilePath relPathDirToFile :: RawFilePath -> RawFilePath -> IO RawFilePath
relPathDirToFile from to = relPathDirToFileAbs <$> absPath from <*> absPath to relPathDirToFile from to = relPathDirToFileAbs <$> absPath from <*> absPath to