summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-02-26 17:04:03 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-02-26 17:04:03 -0400
commit56ea85cd64738777ae460688b5a72f1235277ab8 (patch)
treed90bf51268e1eaa2f7949238dc2c567fb17d5051
parentd8bf510852d6f5728630f5dae5fb2e604a128335 (diff)
document more .git/annex/ contents
-rw-r--r--doc/internals.mdwn36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/internals.mdwn b/doc/internals.mdwn
index 970e88ba0..4e003d9bc 100644
--- a/doc/internals.mdwn
+++ b/doc/internals.mdwn
@@ -27,6 +27,42 @@ Also in [[direct_mode]], some additional data is stored in these directories.
changed, and `.map` files contain a list of file(s) in the work directory
that contain the key.
+# `.git/annex/tmp/`
+
+This directory contains partially transferred objects.
+
+# `.git/annex/misctmp/`
+
+This is a temp directory for miscellaneous other temp files.
+
+While .git/annex/objects and .git/annex/tmp can be put on different
+filesystems if desired, .git/annex/misctmp
+has to be on the same filesystem as the work tree and git repository.
+
+# `.git/annex/bad/`
+
+git-annex fsck puts any bad objects it finds in here.
+
+# `.git/annex/transfers/`
+
+Contains information files for uploads and downloads that are in progress,
+as well as any that have failed. Used especially by the assistant.
+It is safe to delete these files.
+
+# `.git/annex/ssh/`
+
+ssh connection caching files are written in here.
+
+# `.git/annex/index`
+
+This is a git index file which git-annex uses for commits to the git-annex
+branch.
+
+# `.git/annex/journal/`
+
+git-annex uses this to journal changes to the git-annex branch,
+before committing a set of changes.
+
## The git-annex branch
This branch is managed by git-annex, with the contents listed below.