Document pgpPrtParamsSubkeys() returning only signing-capable keys

Since commit a9cca032a2 we've only
returned signing capable subkeys, but this has seemed like an
implementation detail. Make it explicit.

Fixes: #2515
This commit is contained in:
Panu Matilainen 2023-11-15 14:44:42 +02:00
parent 6714ec7068
commit 01fb42d42c
1 changed files with 2 additions and 2 deletions

View File

@ -320,11 +320,11 @@ int pgpPrtParams2(const uint8_t *pkts, size_t pktlen, unsigned int pkttype,
pgpDigParams * ret, char **lints);
/** \ingroup rpmpgp
* Parse subkey parameters from OpenPGP packet(s).
* Parse signing capable subkeys from OpenPGP packet(s).
* @param pkts OpenPGP packet(s)
* @param pktlen OpenPGP packet(s) length (no. of bytes)
* @param mainkey parameters of main key
* @param subkeys array of subkey parameters (alloced)
* @param subkeys array of signing capable subkey parameters (alloced)
* @param subkeysCount count of subkeys
* @return -1 on error, 0 on success
*/