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

documentation for compute remote and associated commands

Browse source 
None of this is implemented yet.
This commit is contained in:
Joey Hess 2025-02-19 14:29:18 -04:00
parent ace9944d1c
commit b5319ec575
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
5 changed files with 209 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

33
doc/special_remotes/compute.mdwn Normal file
View file

@ -0,0 +1,33 @@
While other remotes store the contents of annexed files somewhere,
this special remote uses a program to compute the contents of annexed
files.
To enable an instance of this special remote:
# git-annex initremote myremote type=compute program=git-annex-compute-foo
The `program` parameter is the only required parameter. It is the name of the
program to use to compute the contents of annexed files. It must start with
"git-annex-compute-". The program needs to be installed somewhere in the
`PATH`.
To add a file to a compute special remote, use the [[git-annex-addcomputed]]
command. Once a file has been added to a compute special remote, commands
like `git-annex get` will use it to compute the content of the file.
You can provide other parameters to `initremote`, in order to provide
default configuration values to use when adding files with
[[git-annex-addcomputed]]. To see a list of all the configuration values
supported by a given program, pass `--whatelse` to `initremote`:
# git-annex initremote myremote type=compute program=git-annex-compute-foo --whatelse
## compute programs
To write programs used by the compute special remote, see the
[[design/compute_special_remote_interface]].
Have you written a generally useful (and secure) compute program?
List it here!
* ...