git-annex/doc
Joey Hess 67245ae00f
fully specify the pointer file format
This format is designed to detect accidental appends, while having some
room for future expansion.

Detect when an unlocked file whose content is not present has gotten some
other content appended to it, and avoid treating it as a pointer file, so
that appended content will not be checked into git, but will be annexed
like any other file.

Dropped the max size of a pointer file down to 32kb, it was around 80 kb,
but without any good reason and certianly there are no valid pointer files
anywhere that are larger than 8kb, because it's just been specified what it
means for a pointer file with additional data even looks like.

I assume 32kb will be good enough for anyone. ;-) Really though, it needs
to be some smallish number, because that much of a file in git gets read
into memory when eg, catting pointer files. And since we have no use cases
for the extra lines of a pointer file yet, except possibly to add
some human-visible explanation that it is a git-annex pointer file, 32k
seems as reasonable an arbitrary number as anything. Increasing it would be
possible, eg to 64k, as long as users of such jumbo pointer files didn't
mind upgrading all their git-annex installations to one that supports the
new larger size.

Sponsored-by: Dartmouth College's Datalad project
2022-02-23 14:20:31 -04:00
..
android
Android
assistant
automatic_conflict_resolution
backends
bare_repositories
bugs fully specify the pointer file format 2022-02-23 14:20:31 -04:00
chunking
coding_style
contribute
copies
design document how to resume downloads 2021-10-11 12:40:16 -04:00
devblog comment 2021-11-09 16:04:54 -04:00
direct_mode
download
encryption
footer
forum comment 2022-02-23 11:23:48 -04:00
future_proofing
git-annex-add
git-annex-addurl
git-annex-adjust removed 2022-01-10 08:34:19 +00:00
git-annex-checkpresentkey
git-annex-config
git-annex-copy
git-annex-direct
git-annex-drop
git-annex-enableremote
git-annex-find
git-annex-import
git-annex-importfeed
git-annex-lookupkey
git-annex-metadata
git-annex-move
git-annex-p2p
git-annex-preferred-content
git-annex-reinject
git-annex-rmurl
git-annex-setpresentkey
git-annex-sync
git-annex-test
git-annex-unannex
git-annex-undo
git-annex-uninit
git-annex-unlock
git-annex-unused
git-annex-whereis
how_it_works
install remove xmpp mention 2021-10-19 12:26:22 -04:00
internals fully specify the pointer file format 2022-02-23 14:20:31 -04:00
license
links
metadata
news add news item for git-annex 10.20220222 2022-02-22 13:34:58 -04:00
not
polls
preferred_content
profiling
projects collapse lists of done items by default 2021-11-16 12:38:41 -04:00
required_content
scalability
security
special_remotes comment 2022-02-21 15:59:29 -04:00
stickers
submodules
sync
templates
testimonials
thanks update 2022-01-05 06:44:16 -04:00
tips commeent 2022-01-19 11:56:00 -04:00
todo Added a comment 2022-02-21 21:53:03 +00:00
trust
tuning
upgrades
use_case
users removed 2021-11-04 16:06:17 +00:00
videos
walkthrough comment 2021-09-21 13:23:57 -04:00
workflow
Android.mdwn
assistant.mdwn
automatic_conflict_resolution.mdwn
backends.mdwn
bare_repositories.mdwn
bugs.mdwn
builds.mdwn improve display of subframes 2022-01-27 14:36:40 -04:00
chunking.mdwn
coding_style.mdwn
comments.mdwn
contact.mdwn
contribute.mdwn
copies.mdwn
design.mdwn
devblog.mdwn
direct_mode.mdwn
distributed_version_control.mdwn
download.mdwn
encryption.mdwn
favicon.ico
forum.mdwn
future_proofing.mdwn
git-annex-add.mdwn
git-annex-addunused.mdwn
git-annex-addurl.mdwn
git-annex-adjust.mdwn improve docs 2021-11-12 14:08:36 -04:00
git-annex-assistant.mdwn
git-annex-benchmark.mdwn
git-annex-calckey.mdwn
git-annex-checkpresentkey.mdwn
git-annex-common-options.mdwn
git-annex-config.mdwn
git-annex-contentlocation.mdwn
git-annex-copy.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-dead.mdwn
git-annex-describe.mdwn
git-annex-diffdriver.mdwn
git-annex-direct.mdwn
git-annex-drop.mdwn document another behavior of --auto 2022-02-08 12:22:34 -04:00
git-annex-dropkey.mdwn
git-annex-dropunused.mdwn
git-annex-edit.mdwn
git-annex-enable-tor.mdwn fix name of option 2022-01-21 14:51:57 -04:00
git-annex-enableremote.mdwn
git-annex-examinekey.mdwn
git-annex-expire.mdwn
git-annex-export.mdwn
git-annex-filter-branch.mdwn
git-annex-filter-process.mdwn Avoid git status taking a long time after git-annex unlock of many files. 2022-02-18 15:06:40 -04:00
git-annex-find.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-findref.mdwn
git-annex-fix.mdwn
git-annex-forget.mdwn
git-annex-fromkey.mdwn
git-annex-fsck.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-fuzztest.mdwn
git-annex-get.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-group.mdwn
git-annex-groupwanted.mdwn
git-annex-import.mdwn
git-annex-importfeed.mdwn
git-annex-indirect.mdwn
git-annex-info.mdwn info: Allow using matching options in more situations 2022-02-21 14:46:07 -04:00
git-annex-init.mdwn clarify --version behavior on upgrade 2022-01-26 13:25:01 -04:00
git-annex-initremote.mdwn
git-annex-inprogress.mdwn note about encryption/chunking 2021-10-18 11:11:24 -04:00
git-annex-list.mdwn
git-annex-lock.mdwn
git-annex-log.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-lookupkey.mdwn
git-annex-map.mdwn
git-annex-matchexpression.mdwn
git-annex-matching-expression.mdwn
git-annex-matching-options.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-merge.mdwn
git-annex-metadata.mdwn metadata --batch: Avoid crashing when a non-annexed file is input 2021-11-01 13:40:43 -04:00
git-annex-migrate.mdwn migrate: New --remove-size option 2021-11-12 13:28:28 -04:00
git-annex-mincopies.mdwn
git-annex-mirror.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-move.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-multicast.mdwn
git-annex-numcopies.mdwn
git-annex-p2p.mdwn
git-annex-post-receive.mdwn
git-annex-pre-commit.mdwn
git-annex-preferred-content.mdwn
git-annex-proxy.mdwn
git-annex-readpresentkey.mdwn
git-annex-registerurl.mdwn registerurl,unregisterurl: rework output and support --json 2022-02-14 13:29:20 -04:00
git-annex-reinit.mdwn
git-annex-reinject.mdwn
git-annex-rekey.mdwn migrate: New --remove-size option 2021-11-12 13:28:28 -04:00
git-annex-remotedaemon.mdwn
git-annex-renameremote.mdwn
git-annex-repair.mdwn
git-annex-required.mdwn
git-annex-resolvemerge.mdwn
git-annex-rmurl.mdwn
git-annex-schedule.mdwn
git-annex-semitrust.mdwn
git-annex-setkey.mdwn
git-annex-setpresentkey.mdwn
git-annex-shell.mdwn remove git-annex-shell compat code 2021-10-11 15:36:51 -04:00
git-annex-smudge.mdwn add git-annex filter-process 2021-11-04 15:02:36 -04:00
git-annex-status.mdwn
git-annex-sync.mdwn
git-annex-test.mdwn
git-annex-testremote.mdwn
git-annex-transferkey.mdwn
git-annex-transferkeys.mdwn
git-annex-transferrer.mdwn
git-annex-trust.mdwn
git-annex-unannex.mdwn
git-annex-undo.mdwn
git-annex-ungroup.mdwn
git-annex-uninit.mdwn
git-annex-unlock.mdwn
git-annex-unregisterurl.mdwn registerurl,unregisterurl: rework output and support --json 2022-02-14 13:29:20 -04:00
git-annex-untrust.mdwn
git-annex-unused.mdwn improve docs for refspec format 2021-09-21 13:19:57 -04:00
git-annex-upgrade.mdwn
git-annex-vadd.mdwn
git-annex-vcycle.mdwn
git-annex-version.mdwn
git-annex-vfilter.mdwn
git-annex-vicfg.mdwn
git-annex-view.mdwn
git-annex-vpop.mdwn
git-annex-wanted.mdwn
git-annex-watch.mdwn
git-annex-webapp.mdwn
git-annex-whereis.mdwn --batch-keys 2021-08-25 14:21:12 -04:00
git-annex-whereused.mdwn
git-annex.mdwn complete annex.skipunknown transition 2022-02-18 13:18:05 -04:00
git-remote-tor-annex.mdwn
git-union-merge.mdwn
how_it_works.mdwn
index.mdwn
install.mdwn
internals.mdwn fully specify the pointer file format 2022-02-23 14:20:31 -04:00
license.mdwn
location_tracking.mdwn
logo-old-bw.svg
logo-old.png
logo-old.svg
logo-old_small.png
logo.mdwn
logo.svg
logo_16x16.png
logo_32x32.png
logo_small.png
meta.mdwn
metadata.mdwn
news.mdwn
not.mdwn
polls.mdwn
preferred_content.mdwn
privacy.mdwn
profiling.mdwn
projects.mdwn
publicrepos.mdwn we grew up to over 50TB 2018-09-14 02:53:11 +00:00
related_software.mdwn
repomap.png
required_content.mdwn
scalability.mdwn
security.mdwn
shortcuts.mdwn
sidebar.mdwn
sitemap.mdwn
special_remotes.mdwn
stickers.mdwn
submodules.mdwn
summary.mdwn improve description 2022-01-06 12:24:27 -04:00
sync.mdwn
testimonials.mdwn
thanks.mdwn
tips.mdwn
todo.mdwn
transferring_data.mdwn
trust.mdwn
tuning.mdwn
upgrades.mdwn update, v9 upgrade not yet automatic 2022-01-21 12:36:13 -04:00
users.mdwn
videos.mdwn
walkthrough.mdwn
workflow.mdwn