git-annex/doc/how_it_works.mdwn
Joey Hess b6d46c212e git-annex (5.20140402) unstable; urgency=medium
* unannex, uninit: Avoid committing after every file is unannexed,
    for massive speedup.
  * --notify-finish switch will cause desktop notifications after each
    file upload/download/drop completes
    (using the dbus Desktop Notifications Specification)
  * --notify-start switch will show desktop notifications when each
    file upload/download starts.
  * webapp: Automatically install Nautilus integration scripts
    to get and drop files.
  * tahoe: Pass -d parameter before subcommand; putting it after
    the subcommand no longer works with tahoe-lafs version 1.10.
    (Thanks, Alberto Berti)
  * forget --drop-dead: Avoid removing the dead remote from the trust.log,
    so that if git remotes for it still exist anywhere, git annex info
    will still know it's dead and not show it.
  * git-annex-shell: Make configlist automatically initialize
    a remote git repository, as long as a git-annex branch has
    been pushed to it, to simplify setup of remote git repositories,
    including via gitolite.
  * add --include-dotfiles: New option, perhaps useful for backups.
  * Version 5.20140227 broke creation of glacier repositories,
    not including the datacenter and vault in their configuration.
    This bug is fixed, but glacier repositories set up with the broken
    version of git-annex need to have the datacenter and vault set
    in order to be usable. This can be done using git annex enableremote
    to add the missing settings. For details, see
    http://git-annex.branchable.com/bugs/problems_with_glacier/
  * Added required content configuration.
  * assistant: Improve ssh authorized keys line generated in local pairing
    or for a remote ssh server to set environment variables in an
    alternative way that works with the non-POSIX fish shell, as well
    as POSIX shells.

# imported from the archive
2014-04-02 21:42:53 +01:00

42 lines
2.1 KiB
Markdown

This page gives a high-level view of git-annex. For a detailed
low-level view, see [[the_man_page|git-annex]] and [[internals]].
You do not need to read this page to get started with using git-annex. The
[[walkthrough]] provides step-by-step instructions.
Still reading? Ok. Git's man page calls it "a stupid content
tracker". With git-annex, git is instead "a stupid filename and metadata"
tracker. The contents of annexed files are not stored in git, only the
names of the files and some other metadata remain there.
The contents of the files are kept by git-annex in a distributed key/value
store consisting of every clone of a given git repository. That's a fancy
way to say that git-annex stores the actual file content somewhere under
`.git/annex/`. (See [[internals]] for details and note that in
[[direct_mode]] the file contents are left in the work tree.)
That was the values; what about the keys? Well, a key is calculated for a
given file when it's first added into git-annex. Normally this uses a hash
of its contents, but various [[backends]] can produce different sorts of
keys. The file that gets checked into git is just a symlink to the key
under `.git/annex/`. If the content of a file is modified, that produces
a different key (and the symlink is changed).
A file's content can be [[transferred|transferring_data]] from one
repository to another by git-annex. Which repositories contain a given
value is tracked by git-annex (see [[location_tracking]]). It stores this
tracking information in a separate branch, named "git-annex". All you ever
do with the "git-annex" branch is push/pull it around between repositories,
to [[sync]] up git-annex's view of the world.
That's really all there is to it. Oh, there are [[special_remotes]] that
let values be stored other places than git repositories (anything from
Amazon S3 to a USB key), and there's a pile of commands listed in
[[the_man_page|git-annex]] to handle moving the values around and managing
them. But if you grok the description above, you can see through all that.
It's really just symlinks, keys, values, and a git-annex branch to store
additional metadata.
---
Next: [[install]] or [[walkthrough]]