summaryrefslogtreecommitdiff
path: root/Locations.hs
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-10-03 15:06:58 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-10-03 15:06:58 -0400
commit01111895034873f6b65fcd2ebb86a95de4e6a9e8 (patch)
tree8ce15b744f34138dc2b4e11aea70591cf8b082de /Locations.hs
parent753e26e5e39b0038a634cfc529e6e634f6ca9035 (diff)
rename confusing function
The index.lck file is not a lock file. Kept the historical name for now as changing it would be work.
Diffstat (limited to 'Locations.hs')
-rw-r--r--Locations.hs12
1 files changed, 7 insertions, 5 deletions
diff --git a/Locations.hs b/Locations.hs
index 2e9fd574a..3ef5d7072 100644
--- a/Locations.hs
+++ b/Locations.hs
@@ -35,7 +35,7 @@ module Locations (
gitAnnexJournalDir,
gitAnnexJournalLock,
gitAnnexIndex,
- gitAnnexIndexLock,
+ gitAnnexIndexStatus,
gitAnnexIgnoredRefs,
gitAnnexPidFile,
gitAnnexDaemonStatusFile,
@@ -223,10 +223,12 @@ gitAnnexJournalLock r = gitAnnexDir r </> "journal.lck"
gitAnnexIndex :: Git.Repo -> FilePath
gitAnnexIndex r = gitAnnexDir r </> "index"
-{- Lock file for .git/annex/index. Not to be confused with git's
- - index.lock. -}
-gitAnnexIndexLock :: Git.Repo -> FilePath
-gitAnnexIndexLock r = gitAnnexDir r </> "index.lck"
+{- Holds the ref of the git-annex branch that the index was last updated to.
+ -
+ - The .lck in the name is a historical accident; this is not used as a
+ - lock. -}
+gitAnnexIndexStatus :: Git.Repo -> FilePath
+gitAnnexIndexStatus r = gitAnnexDir r </> "index.lck"
{- List of refs that should not be merged into the git-annex branch. -}
gitAnnexIgnoredRefs :: Git.Repo -> FilePath