restores usage note on sqlite3_rekey behavior for sqlcipher#301 and sqlcipher#383

sjlombardo · sjlombardo · commit a646b5ceddbd · 2021-03-16T11:29:10.000-04:00
diff --git a/src/sqlite.h.in b/src/sqlite.h.in
@@ -5976,6 +5976,19 @@ int sqlite3_key_v2(
 ** The code to implement this API is not available in the public release
 ** of SQLite.
 */
+/* SQLCipher usage note:
+
+   If the current database is plaintext SQLCipher will NOT encrypt it.
+   If the current database is encrypted and pNew==0 or nNew==0, SQLCipher
+   will NOT decrypt it.
+
+   This routine will ONLY work on an already encrypted database in order
+   to change the key.
+
+   Conversion from plaintext-to-encrypted or encrypted-to-plaintext should
+   use an ATTACHed database and the sqlcipher_export() convenience function
+   as per the SQLCipher Documentation.
+*/
 int sqlite3_rekey(
   sqlite3 *db,                   /* Database to be rekeyed */
   const void *pKey, int nKey     /* The new key */
