git-annex/Annex/Version.hs

{- git-annex repository versioning
 -
 - Copyright 2010,2013 Joey Hess <joey@kitenet.net>
 -
 - Licensed under the GNU GPL version 3 or higher.
 -}

{-# LANGUAGE CPP #-}

module Annex.Version where

import Common.Annex
import Config
import qualified Annex

type Version = String

defaultVersion :: Version
defaultVersion = "3"

directModeVersion :: Version
directModeVersion = "5"

supportedVersions :: [Version]
supportedVersions = [defaultVersion, directModeVersion]

upgradableVersions :: [Version]
#ifndef mingw32_HOST_OS
upgradableVersions = ["0", "1", "2", "4"]
#else
upgradableVersions = ["2", "4"]
#endif

autoUpgradeableVersions :: [Version]
autoUpgradeableVersions = ["4"]

versionField :: ConfigKey
versionField = annexConfig "version"

getVersion :: Annex (Maybe Version)
getVersion = annexVersion <$> Annex.getGitConfig

setVersion :: Version -> Annex ()
setVersion = setConfig versionField

removeVersion :: Annex ()
removeVersion = unsetConfig versionField
add 2010-11-08 20:40:42 +00:00			`{- git-annex repository versioning`
			`-`
annex.version is now set to 4 for direct mode repositories To avoid old versions of git-annex getting confused. There is no upgrade required though. We switch back to 3 when going from direct to indirect. 2013-02-26 19:13:10 +00:00			`- Copyright 2010,2013 Joey Hess <joey@kitenet.net>`
add 2010-11-08 20:40:42 +00:00			`-`
			`- Licensed under the GNU GPL version 3 or higher.`
			`-}`

git-annex now builds on Windows (doesn't work) 2013-05-11 20:03:00 +00:00			`{-# LANGUAGE CPP #-}`

rename 2011-10-04 04:40:47 +00:00			`module Annex.Version where`
add 2010-11-08 20:40:42 +00:00
rename 2011-10-05 20:02:51 +00:00			`import Common.Annex`
some reorg and further remote generalization 2011-03-28 01:43:25 +00:00			`import Config`
type based git config handling for remotes Still a couple of places that use git config ad-hoc, but this is most of it done. 2013-01-01 17:52:47 +00:00			`import qualified Annex`
add 2010-11-08 20:40:42 +00:00
Add version command to show git-annex version as well as repository version information. 2011-03-19 18:33:24 +00:00			`type Version = String`

			`defaultVersion :: Version`
start v3 2011-06-21 18:34:08 +00:00			`defaultVersion = "3"`
Add version command to show git-annex version as well as repository version information. 2011-03-19 18:33:24 +00:00
annex.version is now set to 4 for direct mode repositories To avoid old versions of git-annex getting confused. There is no upgrade required though. We switch back to 3 when going from direct to indirect. 2013-02-26 19:13:10 +00:00			`directModeVersion :: Version`
v5 for direct mode, with automatic upgrade This includes storing the current state of the HEAD ref, which git annex sync is going to need, but does not make sync use it. 2013-11-05 20:42:59 +00:00			`directModeVersion = "5"`
annex.version is now set to 4 for direct mode repositories To avoid old versions of git-annex getting confused. There is no upgrade required though. We switch back to 3 when going from direct to indirect. 2013-02-26 19:13:10 +00:00
Add version command to show git-annex version as well as repository version information. 2011-03-19 18:33:24 +00:00			`supportedVersions :: [Version]`
annex.version is now set to 4 for direct mode repositories To avoid old versions of git-annex getting confused. There is no upgrade required though. We switch back to 3 when going from direct to indirect. 2013-02-26 19:13:10 +00:00			`supportedVersions = [defaultVersion, directModeVersion]`
add 2010-11-08 20:40:42 +00:00
No longer auto-upgrade to repository format 2, to avoid accidental upgrades, etc. Use git-annex upgrade when you're ready to run this version. 2011-03-19 22:33:39 +00:00			`upgradableVersions :: [Version]`
get rid of __WINDOWS__, use mingw32_HOST_OS The latter is harder for me to remember, but avoids build failures in code used by the configure program. 2013-08-02 16:27:32 +00:00			`#ifndef mingw32_HOST_OS`
v5 for direct mode, with automatic upgrade This includes storing the current state of the HEAD ref, which git annex sync is going to need, but does not make sync use it. 2013-11-05 20:42:59 +00:00			`upgradableVersions = ["0", "1", "2", "4"]`
git-annex now builds on Windows (doesn't work) 2013-05-11 20:03:00 +00:00			`#else`
v5 for direct mode, with automatic upgrade This includes storing the current state of the HEAD ref, which git annex sync is going to need, but does not make sync use it. 2013-11-05 20:42:59 +00:00			`upgradableVersions = ["2", "4"]`
git-annex now builds on Windows (doesn't work) 2013-05-11 20:03:00 +00:00			`#endif`
No longer auto-upgrade to repository format 2, to avoid accidental upgrades, etc. Use git-annex upgrade when you're ready to run this version. 2011-03-19 22:33:39 +00:00
v5 for direct mode, with automatic upgrade This includes storing the current state of the HEAD ref, which git annex sync is going to need, but does not make sync use it. 2013-11-05 20:42:59 +00:00			`autoUpgradeableVersions :: [Version]`
			`autoUpgradeableVersions = ["4"]`

Fix use of several config settings annex.ssh-options, annex.rsync-options, annex.bup-split-options. And adjust types to avoid the bugs that broke several config settings recently. Now "annex." prefixing is enforced at the type level. 2012-05-06 00:15:32 +00:00			`versionField :: ConfigKey`
			`versionField = annexConfig "version"`
add 2010-11-08 20:40:42 +00:00
improve version checking for v3 Do not set annex.version whenever any command is run. Just do it in init. This ensures that, if a repo has annex.version=3, it has a git-annex branch, so we don't have to run a command every time to check for the branch. Remove the old ad-hoc logic for v0 and v1, to simplify version checking. 2011-06-22 22:07:45 +00:00			`getVersion :: Annex (Maybe Version)`
type based git config handling for remotes Still a couple of places that use git config ad-hoc, but this is most of it done. 2013-01-01 17:52:47 +00:00			`getVersion = annexVersion <$> Annex.getGitConfig`
add 2010-11-08 20:40:42 +00:00
annex.version is now set to 4 for direct mode repositories To avoid old versions of git-annex getting confused. There is no upgrade required though. We switch back to 3 when going from direct to indirect. 2013-02-26 19:13:10 +00:00			`setVersion :: Version -> Annex ()`
			`setVersion = setConfig versionField`
No longer auto-upgrade to repository format 2, to avoid accidental upgrades, etc. Use git-annex upgrade when you're ready to run this version. 2011-03-19 22:33:39 +00:00
uninit: Unset annex.version. Closes: #689852 2012-10-07 20:04:03 +00:00			`removeVersion :: Annex ()`
			`removeVersion = unsetConfig versionField`