git-annex/Upgrade/V8.hs

{- git-annex v8 -> v9 upgrade support
 -
 - Copyright 2022 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU AGPL version 3 or higher.
 -}

{-# LANGUAGE OverloadedStrings #-}

module Upgrade.V8 where

import Annex.Common
import Types.Upgrade
import Config.Smudge

upgrade :: Bool -> Annex UpgradeResult
upgrade automatic = do
	unless automatic $
		showAction "v8 to v9"

	configureSmudgeFilterProcess

	return UpgradeSuccess
add v9 annex.version, not yet the default This is the start of v9, but it's currently identical to v8, and v8 is not upgraded to it. git-annex upgrade will upgrade to v9 with this change. Sponsored-by: Dartmouth College's Datalad project 2022-01-11 18:52:50 +00:00			`{- git-annex v8 -> v9 upgrade support`
			`-`
			`- Copyright 2022 Joey Hess <id@joeyh.name>`
			`-`
			`- Licensed under the GNU AGPL version 3 or higher.`
			`-}`

filter out control characters in all other Messages This does, as a side effect, make long notes in json output not be indented. The indentation is only needed to offset them underneath the display of the file they apply to, so that's ok. Sponsored-by: Brock Spratlen on Patreon 2023-04-10 21:03:41 +00:00			`{-# LANGUAGE OverloadedStrings #-}`

add v9 annex.version, not yet the default This is the start of v9, but it's currently identical to v8, and v8 is not upgraded to it. git-annex upgrade will upgrade to v9 with this change. Sponsored-by: Dartmouth College's Datalad project 2022-01-11 18:52:50 +00:00			`module Upgrade.V8 where`

			`import Annex.Common`
split upgrade into v9 and v10 v10 will run 1 year after the upgrade to v9, to give time for any v8 processes to die. Until that point, the v10 upgrade will be tried by every process but deferred, so added support for deferring upgrades. The upgrade prevention lock file that will be used by v10 is not yet implemented, so it does not yet defer. Sponsored-by: Dartmouth College's Datalad project 2022-01-19 17:06:31 +00:00			`import Types.Upgrade`
enable filter.annex.process in v9 This has tradeoffs, but is generally a win, and users who it causes git add to slow down unacceptably for can just disable it again. It needed to happen in an upgrade, since there are git-annex versions that do not support it, and using such an old version with a v8 repository with filter.annex.process set will cause bad behavior. By enabling it in v9, it's guaranteed that any git-annex version that can use the repository does support it. Although, this is not a perfect protection against problems, since an old git-annex version, if it's used with a v9 repository, will cause git add to try to run git-annex filter-process, which will fail. But at least, the user is unlikely to have an old git-annex in path if they are using a v9 repository, since it won't work in that repository. Sponsored-by: Dartmouth College's Datalad project 2022-01-21 17:11:18 +00:00			`import Config.Smudge`
add v9 annex.version, not yet the default This is the start of v9, but it's currently identical to v8, and v8 is not upgraded to it. git-annex upgrade will upgrade to v9 with this change. Sponsored-by: Dartmouth College's Datalad project 2022-01-11 18:52:50 +00:00
split upgrade into v9 and v10 v10 will run 1 year after the upgrade to v9, to give time for any v8 processes to die. Until that point, the v10 upgrade will be tried by every process but deferred, so added support for deferring upgrades. The upgrade prevention lock file that will be used by v10 is not yet implemented, so it does not yet defer. Sponsored-by: Dartmouth College's Datalad project 2022-01-19 17:06:31 +00:00			`upgrade :: Bool -> Annex UpgradeResult`
add v9 annex.version, not yet the default This is the start of v9, but it's currently identical to v8, and v8 is not upgraded to it. git-annex upgrade will upgrade to v9 with this change. Sponsored-by: Dartmouth College's Datalad project 2022-01-11 18:52:50 +00:00			`upgrade automatic = do`
add upgrade.log The upgrade from V9 uses this to avoid an automatic upgrade until 1 year after the V9 update. It can also be used in future such situations. Sponsored-by: Dartmouth College's Datalad project 2022-01-19 19:51:04 +00:00			`unless automatic $`
			`showAction "v8 to v9"`
add v9 annex.version, not yet the default This is the start of v9, but it's currently identical to v8, and v8 is not upgraded to it. git-annex upgrade will upgrade to v9 with this change. Sponsored-by: Dartmouth College's Datalad project 2022-01-11 18:52:50 +00:00
enable filter.annex.process in v9 This has tradeoffs, but is generally a win, and users who it causes git add to slow down unacceptably for can just disable it again. It needed to happen in an upgrade, since there are git-annex versions that do not support it, and using such an old version with a v8 repository with filter.annex.process set will cause bad behavior. By enabling it in v9, it's guaranteed that any git-annex version that can use the repository does support it. Although, this is not a perfect protection against problems, since an old git-annex version, if it's used with a v9 repository, will cause git add to try to run git-annex filter-process, which will fail. But at least, the user is unlikely to have an old git-annex in path if they are using a v9 repository, since it won't work in that repository. Sponsored-by: Dartmouth College's Datalad project 2022-01-21 17:11:18 +00:00			`configureSmudgeFilterProcess`

add upgrade.log The upgrade from V9 uses this to avoid an automatic upgrade until 1 year after the V9 update. It can also be used in future such situations. Sponsored-by: Dartmouth College's Datalad project 2022-01-19 19:51:04 +00:00			`return UpgradeSuccess`