summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-09-03 14:36:00 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-09-03 14:36:00 -0400
commit4e7315d991fb208ba77aba514ddf5f53a65f928b (patch)
treeccc37dc5661bb66baa5192038666dccc4eade77e /doc
parentf180e741eda5ac16558e481c1e85faec647f8f07 (diff)
parent2afb4de6c02a4515f8b1bf6e24a32cbde7eae5a8 (diff)
Merge branch 'forget'
Conflicts: debian/changelog
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex.mdwn17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 7cac9087d..269588add 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -479,6 +479,23 @@ subdirectories).
Upgrades the repository to current layout.
+* forget
+
+ Causes the git-annex branch to be rewritten, throwing away historical
+ data about past locations of files. The resulting branch will use less
+ space, but `git annex log` will not be able to show where
+ files used to be located.
+
+ To also prune references to repositories that have been marked as dead,
+ specify --drop-dead.
+
+ When this rewritten branch is merged into other clones of
+ the repository, git-annex will automatically perform the same rewriting
+ to their local git-annex branches. So the forgetfulness will automatically
+ propigate out from its starting point until all repositories running
+ git-annex have forgotten their old history. (You may need to force
+ git to push the branch to any git repositories not running git-annex.
+
# QUERY COMMANDS
* version