Skip to content

Commit

Permalink
docs: update archive_progress json description about "finished", see b…
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasWaldmann committed Jul 25, 2022
1 parent a4a2530 commit 404fe33
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions docs/internals/frontends.rst
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

0 comments on commit 404fe33

Please sign in to comment.