mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

better organization and a few wording tweaks

Browse source
This commit is contained in:
Joey Hess 2014-10-31 11:27:05 -04:00
parent 0da54c7ddd
commit a4810a4757
1 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
doc/internals.mdwn
View file

@ -2,7 +2,9 @@ In the world of git, we're not scared about internal implementation
details, and sometimes we like to dive in and tweak things by hand. Here's details, and sometimes we like to dive in and tweak things by hand. Here's
some documentation to that end. some documentation to that end.
## `.git/annex/objects/aa/bb/*/*` ## The .git/ directory
### `.git/annex/objects/aa/bb/*/*`
This is where locally available file contents are actually stored. This is where locally available file contents are actually stored.
Files added to the annex get a symlink checked into git that points Files added to the annex get a symlink checked into git that points
@ -27,11 +29,11 @@ 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 changed, and `.map` files contain a list of file(s) in the work directory
that contain the key. that contain the key.
# `.git/annex/tmp/` ### `.git/annex/tmp/`
This directory contains partially transferred objects. This directory contains partially transferred objects.
# `.git/annex/misctmp/` ### `.git/annex/misctmp/`
This is a temp directory for miscellaneous other temp files. This is a temp directory for miscellaneous other temp files.
@ -39,26 +41,26 @@ While .git/annex/objects and .git/annex/tmp can be put on different
filesystems if desired, .git/annex/misctmp filesystems if desired, .git/annex/misctmp
has to be on the same filesystem as the work tree and git repository. has to be on the same filesystem as the work tree and git repository.
# `.git/annex/bad/` ### `.git/annex/bad/`
git-annex fsck puts any bad objects it finds in here. git-annex fsck puts any bad objects it finds in here.
# `.git/annex/transfers/` ### `.git/annex/transfers/`
Contains information files for uploads and downloads that are in progress, Contains information files for uploads and downloads that are in progress,
as well as any that have failed. Used especially by the assistant. as well as any that have failed. Used especially by the assistant.
It is safe to delete these files. It is safe to delete these files.
# `.git/annex/ssh/` ### `.git/annex/ssh/`
ssh connection caching files are written in here. ssh connection caching files are written in here.
# `.git/annex/index` ### `.git/annex/index`
This is a git index file which git-annex uses for commits to the git-annex This is a git index file which git-annex uses to stage files
branch. when preparing commits to the git-annex branch.
# `.git/annex/journal/` ### `.git/annex/journal/`
git-annex uses this to journal changes to the git-annex branch, git-annex uses this to journal changes to the git-annex branch,
before committing a set of changes. before committing a set of changes.
@ -67,13 +69,9 @@ before committing a set of changes.
This branch is managed by git-annex, with the contents listed below. This branch is managed by git-annex, with the contents listed below.
The file `.git/annex/index` is a separate git index file it uses This branch is not connected to your master, etc branches. It it used for
to accumulate changes for the git-annex branch. internal tracking of information about git-annex repositories and annexed
Also, `.git/annex/journal/` is used to record changes before they objects.
are added to git.
This branch operates on objects exclusively. No file names will ever
be stored in this branch.
The files stored in this branch are all designed to be auto-merged The files stored in this branch are all designed to be auto-merged
using git's [[union merge driver|git-union-merge]]. So each line using git's [[union merge driver|git-union-merge]]. So each line