summaryrefslogtreecommitdiffstats
path: root/openpgp/src/lib.rs
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2020-03-03 14:04:14 +0100
committerJustus Winter <justus@sequoia-pgp.org>2020-03-03 14:04:14 +0100
commit692b6a273befc3df9e32427e6d5c884e83c5f0ff (patch)
tree0296125245128cb22f83eacad1c8602acb29740a /openpgp/src/lib.rs
parentd4a105ba331c4056d31f119c42fecac7d352d124 (diff)
openpgp: Mark experimental features.
- Fixes #446.
Diffstat (limited to 'openpgp/src/lib.rs')
-rw-r--r--openpgp/src/lib.rs12
1 files changed, 11 insertions, 1 deletions
diff --git a/openpgp/src/lib.rs b/openpgp/src/lib.rs
index e61f3742..47518a11 100644
--- a/openpgp/src/lib.rs
+++ b/openpgp/src/lib.rs
@@ -30,9 +30,19 @@
//!
//! [RFC 4880]: https://tools.ietf.org/html/rfc4880
//! [RFC 6637]: https://tools.ietf.org/html/rfc6637
-//! [RFC 4880bis]: https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-05
//! [unhashed signature subpackets]: https://tools.ietf.org/html/rfc4880#section-5.2.3.2
//! [sequoia-core]: ../sequoia_core
+//!
+//! # Experimental Features
+//!
+//! This crate implements functionality from [RFC 4880bis], notable
+//! AEAD encryption containers. As of this writing, this RFC is still
+//! a draft and the syntax or semantic defined in it may change or go
+//! away. Therefore, all related functionality may change and
+//! artifacts created using this functionality may not be usable in
+//! the future. Do not use it for things other than experiments.
+//!
+//! [RFC 4880bis]: https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-08
#![warn(missing_docs)]