Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update archive_progress json description about "finished" #6890

Merged
merged 1 commit into from
Jul 27, 2022
Merged

docs: update archive_progress json description about "finished" #6890

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/internals/frontends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -497,26 +500,26 @@ added:

removed:
See **added** property.

old_mode:
If **type** == '*mode*', then **old_mode** and **new_mode** provide the mode and permissions changes.

new_mode:
See **old_mode** property.

old_user:
If **type** == '*owner*', then **old_user**, **new_user**, **old_group** and **new_group** provide the user
and group ownership changes.

old_group:
See **old_user** property.

new_user:
See **old_user** property.

new_group:
See **old_user** property.


Example (excerpt) of ``borg diff --json-lines``::

Expand Down