security-and-privacy/gnupg
security-and-privacy/gnupg
1
0
Fork 0
mirror of git://git.gnupg.org/gnupg.git synced 2025-01-02 12:01:32 +01:00
Code Activity

doc: expand documentation of PROGRESS message

Browse Source 
--
This answers two questions that I was only able to answer by examining
each site where PROGRESS messages are emitted, and fixes a typo.

Signed-off-by: Will Thompson <wjt@endlessm.com>
This commit is contained in:
Will Thompson 2017-11-14 15:30:34 +00:00 committed by Werner Koch
parent b062ea5bc2
commit 49635b454b
No known key found for this signature in database
GPG Key ID: E3FDFF218E45B72B
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/DETAILS
View File

@ -1041,15 +1041,16 @@ pkd:0:1024:B665B1435F4C2 .... FF26ABB:
- 4 :: Key is stored on a smartcard. - 4 :: Key is stored on a smartcard.
*** PROGRESS <what> <char> <cur> <total> [<units>] *** PROGRESS <what> <char> <cur> <total> [<units>]
Used by the primegen and Public key functions to indicate Used by the primegen and public key functions to indicate
progress. <char> is the character displayed with no --status-fd progress. <char> is the character displayed with no --status-fd
enabled, with the linefeed replaced by an 'X'. <cur> is the enabled, with the linefeed replaced by an 'X'. <cur> is the
current amount done and <total> is amount to be done; a <total> of current amount done and <total> is amount to be done; a <total> of
0 indicates that the total amount is not known. The condition 0 indicates that the total amount is not known. Both are
non-negative integers. The condition
: TOTAL && CUR == TOTAL : TOTAL && CUR == TOTAL
may be used to detect the end of an operation. may be used to detect the end of an operation.
Well known values for WHAT are: Well known values for <what> are:
- pk_dsa :: DSA key generation - pk_dsa :: DSA key generation
- pk_elg :: Elgamal key generation - pk_elg :: Elgamal key generation
@ -1064,7 +1065,9 @@ pkd:0:1024:B665B1435F4C2 .... FF26ABB:
the data of a smartcard. the data of a smartcard.
- card_busy :: A smartcard is still working - card_busy :: A smartcard is still working
<units> is sometines used to describe the units for <current> and When <what> refers to a file path, it may be truncated.
<units> is sometimes used to describe the units for <current> and
<total>. For example "B", "KiB", or "MiB". <total>. For example "B", "KiB", or "MiB".
*** BACKUP_KEY_CREATED <fingerprint> <fname> *** BACKUP_KEY_CREATED <fingerprint> <fname>