summaryrefslogtreecommitdiff
path: root/doc/upgrades.mdwn
diff options
context:
space:
mode:
authorGravatar https://id.koumbit.net/anarcat <https://id.koumbit.net/anarcat@web>2015-06-03 14:24:28 +0000
committerGravatar admin <admin@branchable.com>2015-06-03 14:24:28 +0000
commit1fc35f26410e68ebd083d665217264e0b478deb3 (patch)
tree4a8e8e9708da0a04ce16c335d2d1c16efd8308d3 /doc/upgrades.mdwn
parentab55edd55e1add38051819da62f341dfbb9c0ce6 (diff)
document the software upgrade process minimally
Diffstat (limited to 'doc/upgrades.mdwn')
-rw-r--r--doc/upgrades.mdwn12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/upgrades.mdwn b/doc/upgrades.mdwn
index 6cf2784e7..2aef01ef9 100644
--- a/doc/upgrades.mdwn
+++ b/doc/upgrades.mdwn
@@ -1,3 +1,15 @@
+[[!toc levels=2]]
+
+# Software upgrades
+
+Upgrading the code base of git-annex will be done differently depending on your [[install]] method. For most distribution-based packages, it is handled by the package management software.
+
+For the standalone distribution, the [[git-annex-webapp]](1) will ask the user for confirmation when it detects a new version. Once that is confirmed, or if `annex.autoupgrade` is enabled (see the [[git-annex]](1) manpage) the assistant will start the upgrade. The upgrade process is fairly simple: the assistant will move the `git-annex.linux` directory out of the way and replace it with the new version, then re-execute itself. It therefore needs write access to the parent directory of the `git-annex.linux` directory.
+
+Note that "upgrading" from a distribution-based package to the [[install/Linux_standalone/]] version may cause weird problems, as an unexpected version of git-annex (e.g. the old one from packages) may be ran, see [[bugs/git-annex-shell_doesn__39__t_work_as_expected/]] for a full discussion.
+
+# Repository upgrades
+
Occasionally improvements are made to how git-annex stores its data,
that require an upgrade process to convert repositories made with an older
version to be used by a newer version. It's annoying, it should happen