Skip to content

Commit

Permalink
Clarify pgpParsePkts() and pgpReadPkts() API docs
Browse files Browse the repository at this point in the history
Both process exactly one ASCII-armored block, this wasn't clear in
the docs.

Fixes: rpm-software-management#2387
  • Loading branch information
pmatilai committed Nov 29, 2023
1 parent 1cd9f90 commit bccf58f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions include/rpm/rpmpgp.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit bccf58f

Please sign in to comment.