Update crypt_repair API documentation for LUKS2.

This commit is contained in:
Ondrej Kozina
2018-07-09 17:27:55 +02:00
committed by Milan Broz
parent 9de5dc932b
commit c122889c95

View File

@@ -624,7 +624,7 @@ int crypt_load(struct crypt_device *cd,
void *params); void *params);
/** /**
* Try to repair crypt device LUKS1 on-disk header if invalid. * Try to repair crypt device LUKS on-disk header if invalid.
* *
* @param cd crypt device handle * @param cd crypt device handle
* @param requested_type @link crypt-type @endlink or @e NULL for all known * @param requested_type @link crypt-type @endlink or @e NULL for all known
@@ -632,9 +632,11 @@ int crypt_load(struct crypt_device *cd,
* *
* @returns 0 on success or negative errno value otherwise. * @returns 0 on success or negative errno value otherwise.
* *
* @note Does not support LUKS2 devices explicitly. LUKS2 header is auto-repaired * @note For LUKS2 device crypt_repair bypass blkid checks and
* (if exactly one header checksum does not match) automatically on * perform auto-recovery even though there're third party device
* crypt_load(). * signatures found by blkid probes. Currently the crypt_repair on LUKS2
* works only if exactly one header checksum does not match or exactly
* one header is missing.
*/ */
int crypt_repair(struct crypt_device *cd, int crypt_repair(struct crypt_device *cd,
const char *requested_type, const char *requested_type,