Clarify pgpParsePkts() and pgpReadPkts() API docs

Both process exactly one ASCII-armored block, this wasn't clear in
the docs.

Fixes: #2387
This commit is contained in:
Panu Matilainen 2023-11-29 13:18:33 +02:00
parent 1cd9f9077a
commit bccf58f0d4
1 changed files with 2 additions and 2 deletions

View File

@ -333,7 +333,7 @@ int pgpPrtParamsSubkeys(const uint8_t *pkts, size_t pktlen,
int *subkeysCount);
/** \ingroup rpmpgp
* Parse armored OpenPGP packets from a file.
* Parse the OpenPGP packets from one ASCII-armored block in a file.
* @param fn file name
* @param[out] pkt dearmored OpenPGP packet(s) (malloced)
* @param[out] pktlen dearmored OpenPGP packet(s) length in bytes
@ -342,7 +342,7 @@ int pgpPrtParamsSubkeys(const uint8_t *pkts, size_t pktlen,
pgpArmor pgpReadPkts(const char * fn, uint8_t ** pkt, size_t * pktlen);
/** \ingroup rpmpgp
* Parse armored OpenPGP packets from memory.
* Parse the OpenPGP packets from one ASCII-armored block in memory.
* @param armor armored OpenPGP packet string
* @param[out] pkt dearmored OpenPGP packet(s) (malloced)
* @param[out] pktlen dearmored OpenPGP packet(s) length in bytes