eessppeelllloo/cryptsetup
1
0
Fork 0
mirror of https://gitlab.com/cryptsetup/cryptsetup.git synced 2025-12-06 00:10:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix misleading parameter name in crypt_keyfile_device_read.

Browse Source 
This patch has no functional impact. It only renames misleading
parameter 'keyfile_size_max' to 'key_size' because that's
how it's actually interpreted since beginning. Also updated
API documentation accordingly.
This commit is contained in:
Ondrej Kozina
2018-07-13 09:34:55 +02:00
committed by Milan Broz
parent b60e856087
commit 9895edefff
2 changed files with 19 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
lib/libcryptsetup.h
View File

@@ -1616,17 +1616,20 @@ void crypt_set_debug_level(int level);
* @param keyfile keyfile to read
* @param key buffer for key
* @param key_size_read size of read key
* @param keyfile_offset keyfile offset
* @param keyfile_size_max maximal size of keyfile to read
* @param keyfile_offset key offset in keyfile
* @param key_size exact key length to read from file or 0
* @param flags keyfile read flags
*
* @return @e 0 on success or negative errno value otherwise.
*
* @note If key_size is set to zero we read internal max length
* and actual size read is returned via key_size_read parameter.
*/
int crypt_keyfile_device_read(struct crypt_device *cd,
const char *keyfile,
char **key, size_t *key_size_read,
uint64_t keyfile_offset,
size_t keyfile_size_max,
size_t key_size,
uint32_t flags);
/**
@@ -1636,7 +1639,7 @@ int crypt_keyfile_read(struct crypt_device *cd,
const char *keyfile,
char **key, size_t *key_size_read,
size_t keyfile_offset,
size_t keyfile_size_max,
size_t key_size,
uint32_t flags);
/** Read key only to the first end of line (\\n). */