lib.ipsec.esp:encapsulate: document clobbering effect.

snabbco · Jan 20, 2016 · e1abe8e · e1abe8e
1 parent 985c469
commit e1abe8e
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/lib/ipsec/README.md b/src/lib/ipsec/README.md
@@ -36,7 +36,8 @@ be a table with the following keys:
 — Method **esp_v6_encrypt:encapsulate** *packet*
 
 Returns a freshly allocated packet that is the encrypted and encapsulated
-version of *packet*.
+version of *packet*. The contents of *packet* are destroyed in the
+process.
 
 — Method **esp_v6_decrypt:decapsulate** *packet*