Blame SOURCES/cryptsetup-2.0.4-update-crypt_repair-API-documentation-for-LUKS2.patch

8af939
From 167da99eaa9708289492e8fca2ebe4964cf5baa7 Mon Sep 17 00:00:00 2001
8af939
From: Ondrej Kozina <okozina@redhat.com>
8af939
Date: Mon, 9 Jul 2018 17:27:55 +0200
8af939
Subject: [PATCH 5/6] Update crypt_repair API documentation for LUKS2.
8af939
8af939
---
8af939
 lib/libcryptsetup.h | 10 ++++++----
8af939
 1 file changed, 6 insertions(+), 4 deletions(-)
8af939
8af939
diff --git a/lib/libcryptsetup.h b/lib/libcryptsetup.h
8af939
index 0a7ebdb..2d959fa 100644
8af939
--- a/lib/libcryptsetup.h
8af939
+++ b/lib/libcryptsetup.h
8af939
@@ -624,7 +624,7 @@ int crypt_load(struct crypt_device *cd,
8af939
 	void *params);
8af939
 
8af939
 /**
8af939
- * Try to repair crypt device LUKS1 on-disk header if invalid.
8af939
+ * Try to repair crypt device LUKS on-disk header if invalid.
8af939
  *
8af939
  * @param cd crypt device handle
8af939
  * @param requested_type @link crypt-type @endlink or @e NULL for all known
8af939
@@ -632,9 +632,11 @@ int crypt_load(struct crypt_device *cd,
8af939
  *
8af939
  * @returns 0 on success or negative errno value otherwise.
8af939
  *
8af939
- * @note Does not support LUKS2 devices explicitly. LUKS2 header is auto-repaired
8af939
- *	 (if exactly one header checksum does not match) automatically on
8af939
- *	 crypt_load().
8af939
+ * @note For LUKS2 device crypt_repair bypass blkid checks and
8af939
+ * 	 perform auto-recovery even though there're third party device
8af939
+ * 	 signatures found by blkid probes. Currently the crypt_repair on LUKS2
8af939
+ * 	 works only if exactly one header checksum does not match or exactly
8af939
+ * 	 one header is missing.
8af939
  */
8af939
 int crypt_repair(struct crypt_device *cd,
8af939
 	const char *requested_type,
8af939
-- 
8af939
1.8.3.1
8af939