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

update

Browse source
This commit is contained in:
Joey Hess 2025-02-20 13:27:59 -04:00
parent a2fa2a8c5f
commit 4f3d9f8115
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
1 changed files with 15 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

26
doc/design/compute_special_remote_interface.mdwn
View file

@ -51,12 +51,16 @@ In the example above, the program is expected to output something like:
If possible, the program should write the content of the file it is If possible, the program should write the content of the file it is
computing directly to the file listed in COMPUTING, rather than writing to computing directly to the file listed in COMPUTING, rather than writing to
somewhere else and renaming it at the end. If git-annex sees that the file somewhere else and renaming it at the end. Except, when the program writes
corresponding to the key it requested be computed is growing, it will use the file it computes out of order, it should write to a file somewhere else
its file size when displaying progress to the user. and rename it at the end.
If git-annex sees that the file corresponding to the key it requested be
computed is growing, it will use its file size when displaying progress to
the user.
The program can also output lines to stdout to indicate its current The program can also output lines to stdout to indicate its current
progress. progress:
PROGRESS 50% PROGRESS 50%
@ -67,23 +71,23 @@ output, but not for progress displays.
If the program exits nonzero, nothing it computed will be stored in the If the program exits nonzero, nothing it computed will be stored in the
git-annex repository. git-annex repository.
The program must also support listing the inputs and outputs that it When run with the "interface" parameter, the program must describe its
interface. This is a list of the inputs and outputs that it
supports. This allows `git-annex addcomputed` and `git-annex initremote` to supports. This allows `git-annex addcomputed` and `git-annex initremote` to
list inputs and outputs, and also lets them reject invalid inputs and list inputs and outputs, and also lets them reject invalid inputs and
outputs. outputs.
In this mode, the program is run with a "list" parameter. The output is lines, in the form:
It should output lines, in the form:
INPUT[?] Name Description INPUT[?] Id Description
VALUE[?] Name Description VALUE[?] Id Description
OUTPUT Id Description OUTPUT Id Description
Use "INPUT" when a file is an input to the computation, Use "INPUT" when a file is an input to the computation,
and "VALUE" for all other input values. Use "INPUT?" and "VALUE?" and "VALUE" for all other input values. Use "INPUT?" and "VALUE?"
for optional inputs and values. for optional inputs and values.
The program can also optionally output a "REPRODUCIBLE" line. The interface can also optionally include a "REPRODUCIBLE" line.
That indicates that the results of its computations are That indicates that the results of its computations are
expected to be bit-for-bit reproducible. expected to be bit-for-bit reproducible.
That makes `git-annex addcomputed` behave as if the `--reproducible` That makes `git-annex addcomputed` behave as if the `--reproducible`
@ -93,7 +97,7 @@ An example `git-annex-compute-foo` shell script follows:
#!/bin/sh #!/bin/sh
set -e set -e
if [ "$1" = list ]; then if [ "$1" = interface ]; then
echo "INPUT raw A photo in RAW format" echo "INPUT raw A photo in RAW format"
echo "VALUE? passes Number of passes" echo "VALUE? passes Number of passes"
echo "OUTPUT photo Computed JPEG" echo "OUTPUT photo Computed JPEG"