diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2020-01-07 15:53:15 +0100 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2020-01-07 15:53:15 +0100 |
| commit | c3f0c59bf7d826cc955e38bcac68fb336038e67d (patch) | |
| tree | 1a45942422698f774069b1f1ae613475dabb69ad | |
| parent | d4e05895735fd2acf3e9a10fd24a00b405b43f48 (diff) | |
openpgp: Improve documentation.
| -rw-r--r-- | openpgp/src/serialize/mod.rs | 8 | ||||
| -rw-r--r-- | openpgp/src/serialize/padding.rs | 5 |
2 files changed, 10 insertions, 3 deletions
diff --git a/openpgp/src/serialize/mod.rs b/openpgp/src/serialize/mod.rs index 20e5b92f..3d74aa4f 100644 --- a/openpgp/src/serialize/mod.rs +++ b/openpgp/src/serialize/mod.rs @@ -5,9 +5,13 @@ //! already assembled in memory, with all information already in place //! (e.g. because it was parsed). //! -//! If it is, you can use the `Serialize` or `SerializeKey`. +//! If it is, you can use the [`Serialize`] or [`SerializeInto`] +//! trait. Otherwise, please use our [streaming serialization +//! interface]. //! -//! Otherwise, please use our streaming serialization interface. +//! [`Serialize`]: trait.Serialize.html +//! [`SerializeInto`]: trait.SerializeInto.html +//! [streaming serialization interface]: stream/index.html use std::io::{self, Write}; use std::cmp; diff --git a/openpgp/src/serialize/padding.rs b/openpgp/src/serialize/padding.rs index 3ad70fd6..05587b09 100644 --- a/openpgp/src/serialize/padding.rs +++ b/openpgp/src/serialize/padding.rs @@ -28,7 +28,10 @@ //! transparent for the recipient (for example, no weird packets are //! inserted). //! -//! Cursory testing (OpenKeychain, GnuPG) revealed no problems. +//! Cursory [testing] (RNP, DKGPG, PGPy, OpenKeychain, GnuPG classic +//! and modern) revealed no problems. +//! +//! [testing]: https://tests.sequoia-pgp.org/#Encrypt-Decrypt_roundtrip_with_key__Bob___AES256 //! //! To be effective, the padding layer must be placed inside the //! encryption container. To increase compatibility, the padding |