untested transition detection on merging, and transition running code

1 files changed, 18 insertions, 0 deletions

diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 7cac9087d..72e376d64 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -479,6 +479,24 @@ 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, files that are no longer present on
+  any remote, etc. The resulting branch will use less space, but for
+  example `git annex log` will not be able to show where files used to
+  be located.
+  
+  To also prune references to remotes that have been marked as dead,
+  specify --forget-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 branch. 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