mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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
parent a75b260fef c7e719f209
commit 19509f5fa5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/internals/frontends.rst
View File

@ -50,17 +50,20 @@ archive_progress
The following keys exist, each represents the current progress. The following keys exist, each represents the current progress.
original_size 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 Compressed size (may be empty/absent)
deduplicated_size deduplicated_size
Deduplicated size Deduplicated size (may be empty/absent)
nfiles nfiles
Number of (regular) files processed so far Number of (regular) files processed so far (may be empty/absent)
path path
Current path Current path (may be empty/absent)
time time
Unix timestamp (float) 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 progress_message
A message-based progress information with no concrete progress information, just a message A message-based progress information with no concrete progress information, just a message
@ -497,26 +500,26 @@ added:
removed: removed:
See **added** property. See **added** property.
old_mode: old_mode:
If **type** == '*mode*', then **old_mode** and **new_mode** provide the mode and permissions changes. If **type** == '*mode*', then **old_mode** and **new_mode** provide the mode and permissions changes.
new_mode: new_mode:
See **old_mode** property. See **old_mode** property.
old_user: old_user:
If **type** == '*owner*', then **old_user**, **new_user**, **old_group** and **new_group** provide the user If **type** == '*owner*', then **old_user**, **new_user**, **old_group** and **new_group** provide the user
and group ownership changes. and group ownership changes.
old_group: old_group:
See **old_user** property. See **old_user** property.
new_user: new_user:
See **old_user** property. See **old_user** property.
new_group: new_group:
See **old_user** property. See **old_user** property.
Example (excerpt) of ``borg diff --json-lines``:: Example (excerpt) of ``borg diff --json-lines``::