aboutsummaryrefslogtreecommitdiff
path: root/Utility/Path.hs
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2016-01-05 17:33:48 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2016-01-05 17:33:48 -0400
commit8728cd00ff2e9b9c40325a7e700ab25644bb347b (patch)
tree520b0971ba120e8c4f92bfd724edbc1f21d3ae79 /Utility/Path.hs
parent903241502a6ad1a4845ac2d131ef7fc2b547400d (diff)
clarify absPathFrom
The repo path is typically relative, not absolute, so providing it to absPathFrom doesn't yield an absolute path. This is not a bug, just unclear documentation. Indeed, there seem to be no reason to simplifyPath here, which absPathFrom does, so instead just combine the repo path and the TopFilePath. Also, removed an export of the TopFilePath constructor; asTopFilePath is provided to construct one as-is.
Diffstat (limited to 'Utility/Path.hs')
-rw-r--r--Utility/Path.hs2
1 files changed, 1 insertions, 1 deletions
diff --git a/Utility/Path.hs b/Utility/Path.hs
index f3290d8d9..2f7802048 100644
--- a/Utility/Path.hs
+++ b/Utility/Path.hs
@@ -60,7 +60,7 @@ simplifyPath path = dropTrailingPathSeparator $
{- Makes a path absolute.
-
- The first parameter is a base directory (ie, the cwd) to use if the path
- - is not already absolute.
+ - is not already absolute, and should itsef be absolute.
-
- Does not attempt to deal with edge cases or ensure security with
- untrusted inputs.