summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNeal H. Walfield <neal@pep.foundation>2020-04-29 15:40:46 +0200
committerNeal H. Walfield <neal@pep.foundation>2020-05-05 10:55:25 +0200
commit8c5e93e2eb716426239a31f67bc12aeb0a575f17 (patch)
treeaf65fc76649577285189d236ec1542bf406611a1
parent4083319ae3ad384b2da5cb52c52013389d571745 (diff)
openpgp: Move the "Common Operations" section closer to the front
- This will hopefully make it harder to overlook.
-rw-r--r--openpgp/src/cert/mod.rs58
1 files changed, 29 insertions, 29 deletions
diff --git a/openpgp/src/cert/mod.rs b/openpgp/src/cert/mod.rs
index e5135f50..064a56b0 100644
--- a/openpgp/src/cert/mod.rs
+++ b/openpgp/src/cert/mod.rs
@@ -25,6 +25,35 @@
//! signee's certificate, and are used by trust models like the Web of
//! Trust to authenticate certificates.
//!
+//! # Common Operations
+//!
+//! - *Generating a certificate*: See the [`CertBuilder`] module.
+//! - *Parsing a certificate*: See the [`Parser` implementation] for `Cert`.
+//! - *Parsing a keyring*: See the [`CertParser`] module.
+//! - *Serializing a certificate*: See the [`Serialize`
+//! implementation] for `Cert`, and the [`Cert::as_tsk`] method to
+//! also include any secret key material.
+//! - *Using a certificate*: See the [`Cert`] and [`ValidCert`] data structures.
+//! - *Revoking a certificate*: See the [`CertRevocationBuilder`] data structure.
+//! - *Merging packets*: See the [`Cert::merge_packets`] method.
+//! - *Merging certificates*: See the [`Cert::merge`] method.
+//! - *Creating third-party certifications*: See the [`UserID::certify`]
+//! and [`UserAttribute::certify`] methods.
+//! - *Using User IDs and User Attributes*: See the [`ComponentAmalgamation`] module.
+//! - *Using keys*: See the [`KeyAmalgamation`] module.
+//! - *Updating a binding signature*: See the [`UserID::bind`],
+//! [`UserAttribute::bind`], and [`Key::bind`] methods.
+//! - *Checking third-party signatures*: See the
+//! [`Signature::verify_direct_key`],
+//! [`Signature::verify_userid_binding`], and
+//! [`Signature::verify_user_attribute_binding`] methods.
+//! - *Checking third-party revocations*: See the
+//! [`ValidCert::revocation_keys`],
+//! [`ValidAmalgamation::revocation_keys`],
+//! [`Signature::verify_primary_key_revocation`],
+//! [`Signature::verify_userid_revocation`],
+//! [`Signature::verify_user_attribute_revocation`] methods.
+//!
//! # Data Structures
//!
//! ## `Cert`
@@ -78,35 +107,6 @@
//! `ComponentBundle`, and that would create a self-referential data
//! structure, which is currently not supported in Rust.
//!
-//! # Common Operations
-//!
-//! - *Generating a certificate*: See the [`CertBuilder`] module.
-//! - *Parsing a certificate*: See the [`Parser` implementation] for `Cert`.
-//! - *Parsing a keyring*: See the [`CertParser`] module.
-//! - *Serializing a certificate*: See the [`Serialize`
-//! implementation] for `Cert`, and the [`Cert::as_tsk`] method to
-//! also include any secret key material.
-//! - *Using a certificate*: See the [`Cert`] and [`ValidCert`] data structures.
-//! - *Revoking a certificate*: See the [`CertRevocationBuilder`] data structure.
-//! - *Merging packets*: See the [`Cert::merge_packets`] method.
-//! - *Merging certificates*: See the [`Cert::merge`] method.
-//! - *Creating third-party certifications*: See the [`UserID::certify`]
-//! and [`UserAttribute::certify`] methods.
-//! - *Using User IDs and User Attributes*: See the [`ComponentAmalgamation`] module.
-//! - *Using keys*: See the [`KeyAmalgamation`] module.
-//! - *Updating a binding signature*: See the [`UserID::bind`],
-//! [`UserAttribute::bind`], and [`Key::bind`] methods.
-//! - *Checking third-party signatures*: See the
-//! [`Signature::verify_direct_key`],
-//! [`Signature::verify_userid_binding`], and
-//! [`Signature::verify_user_attribute_binding`] methods.
-//! - *Checking third-party revocations*: See the
-//! [`ValidCert::revocation_keys`],
-//! [`ValidAmalgamation::revocation_keys`],
-//! [`Signature::verify_primary_key_revocation`],
-//! [`Signature::verify_userid_revocation`],
-//! [`Signature::verify_user_attribute_revocation`] methods.
-//!
//! [Section 11.1]: https://tools.ietf.org/html/rfc4880#section-11.1
//! [`Cert`]: struct.Cert.html
//! [`ComponentBundle`]: bindle/index.html