summaryrefslogtreecommitdiff
path: root/doc/internals.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-06-23 11:37:26 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-06-23 11:37:26 -0400
commit5f494154a34bad7cc54915a2a408b830e8ca77be (patch)
tree2adfc75ea36e18b3655bb2dcfa94b702288fc6c5 /doc/internals.mdwn
parent23e765b67c38a9f02b3b5152e7e123819bb696de (diff)
add journaling to speed up changes to the git-annex branch
git is slow when the index file is large and has to be rewritten each time a file is changed. To speed this up, added a journal where changes are recorded before being fed into the index file and committed to the git-annex branch. The entire journal can be fed into git with just 2 commands, and only one write of the index file.
Diffstat (limited to 'doc/internals.mdwn')
-rw-r--r--doc/internals.mdwn10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/internals.mdwn b/doc/internals.mdwn
index aaa125599..27b5bb1f2 100644
--- a/doc/internals.mdwn
+++ b/doc/internals.mdwn
@@ -21,9 +21,13 @@ deleting or changing the file contents.
This branch is managed by git-annex, with the contents listed below.
-Note that git-annex assumes only it will modify this branch. If you go in
-and make changes directly, it will probably revert your changes in its next
-commit to the branch.
+The file `.git/index.git-annex` is a separate git index file it uses
+to accumlate changes for the branch. Also, `.git/annex/journal/` is used
+to record changes before they are added to git.
+
+Note that for speed reasons, git-annex assumes only it will modify this
+branch. If you go in and make changes directly, it will probably revert
+your changes in its next commit to the branch.
The best way to make changes to the git-annex branch is instead
to create a branch of it, with a name like "my/git-annex", and then