Merge pull request #6889 from ThomasWaldmann/archive-progress-json-docs-master

docs: update archive_progress json description about "finished"
This commit is contained in:
TW 2022-07-27 12:47:12 +02:00 committed by GitHub
commit 19509f5fa5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 10 deletions

View File

@ -50,17 +50,20 @@ archive_progress
The following keys exist, each represents the current progress.
original_size
Original size of data processed so far (before compression and deduplication)
Original size of data processed so far (before compression and deduplication, may be empty/absent)
compressed_size
Compressed size
Compressed size (may be empty/absent)
deduplicated_size
Deduplicated size
Deduplicated size (may be empty/absent)
nfiles
Number of (regular) files processed so far
Number of (regular) files processed so far (may be empty/absent)
path
Current path
Current path (may be empty/absent)
time
Unix timestamp (float)
finished
boolean indicating whether the operation has finished, only the last object for an *operation*
can have this property set to *true*.
progress_message
A message-based progress information with no concrete progress information, just a message