summaryrefslogtreecommitdiffstats
path: root/openpgp
diff options
context:
space:
mode:
authorNora Widdecke <nora@sequoia-pgp.org>2021-08-25 11:47:23 +0200
committerNora Widdecke <nora@sequoia-pgp.org>2021-08-27 12:58:07 +0200
commita7ffba7e699b5e841dc35104278877da39e9ba22 (patch)
treef87f238c431c05b01036827036fa4cf56602cba0 /openpgp
parent83e6668ed4b5692a0a52174031f99c1e76726f77 (diff)
openpgp: Correct links.
- Some link targets have moved or were replaced since the link's creation. Make them point to the new location or replacement.
Diffstat (limited to 'openpgp')
-rw-r--r--openpgp/src/cert.rs14
-rw-r--r--openpgp/src/cert/amalgamation.rs6
-rw-r--r--openpgp/src/packet/key.rs3
-rw-r--r--openpgp/src/packet/signature.rs3
-rw-r--r--openpgp/src/packet/signature/subpacket.rs4
-rw-r--r--openpgp/src/parse/map.rs6
-rw-r--r--openpgp/src/regex/mod.rs4
-rw-r--r--openpgp/src/types/revocation_key.rs4
-rw-r--r--openpgp/src/types/timestamp.rs4
9 files changed, 25 insertions, 23 deletions
diff --git a/openpgp/src/cert.rs b/openpgp/src/cert.rs
index 77c99091..f0f51e46 100644
--- a/openpgp/src/cert.rs
+++ b/openpgp/src/cert.rs
@@ -112,7 +112,7 @@
//! [`ComponentBundle`]: bundle::ComponentBundle
//! [`ComponentAmalgamation`]: amalgamation::ComponentAmalgamation
//! [`Parser` implementation]: struct.Cert.html#impl-Parse%3C%27a%2C%20Cert%3E
-//! [`Serialize` implementation]: struct.Cert.html#impl-Serialize%3C%27a%2C%20Cert%3E
+//! [`Serialize` implementation]: struct.Cert.html#impl-Serialize
//! [`UserID::certify`]: crate::packet::UserID::certify()
//! [`UserAttribute::certify`]: crate::packet::user_attribute::UserAttribute::certify()
//! [`KeyAmalgamation`]: amalgamation::key
@@ -839,9 +839,13 @@ impl Cert {
/// [hard revocation]: crate::types::RevocationType::Hard
///
/// Note: certificates and subkeys have different revocation
- /// criteria from [User IDs and User Attributes].
+ /// criteria from [User IDs] and [User Attributes].
///
- /// [User IDs and User Attributes]: amalgamation::ComponentAmalgamation::revocation_status()
+ // Pending https://github.com/rust-lang/rust/issues/85960, should be
+ // [User IDs]: bundle::ComponentBundle<UserID>::revocation_status
+ // [User Attributes]: bundle::ComponentBundle<UserAttribute>::revocation_status
+ /// [User IDs]: bundle::ComponentBundle#method.revocation_status-1
+ /// [User Attributes]: bundle::ComponentBundle#method.revocation_status-2
///
/// # Examples
///
@@ -2798,11 +2802,11 @@ impl Cert {
///
/// This doesn't say anything about whether the certificate itself
/// is alive (see [`ValidCert::alive`]) or revoked (see
- /// [`ValidCert::revoked`]).
+ /// [`ValidCert::revocation_status`]).
///
/// [`ValidateAmalgamation`]: amalgamation::ValidateAmalgamation
/// [`ValidCert::alive`]: ValidCert::alive()
- /// [`ValidCert::revoked`]: ValidCert::revoked()
+ /// [`ValidCert::revocation_status`]: ValidCert::revocation_status()
///
/// # Examples
///
diff --git a/openpgp/src/cert/amalgamation.rs b/openpgp/src/cert/amalgamation.rs
index b8db814c..9d01d86f 100644
--- a/openpgp/src/cert/amalgamation.rs
+++ b/openpgp/src/cert/amalgamation.rs
@@ -216,7 +216,7 @@
//! [`std::iter::map`]: std::iter::Map
//! [MD5 collisions]: https://en.wikipedia.org/wiki/MD5
//! [`Policy`]: crate::policy::Policy
-//! [streaming verifier]: ../../parse/stream.html
+//! [streaming verifier]: crate::parse::stream
//! [Intended Recipients]: https://tools.ietf.org/html/draft-ietf-openpgp-rfc4880bis-09.html#name-intended-recipient-fingerpr
//! [signature expirations]: https://tools.ietf.org/html/rfc4880#section-5.2.3.10
//! [`Deref` trait]: std::ops::Deref
@@ -650,7 +650,7 @@ pub trait ValidAmalgamation<'a, C: 'a>: seal::Sealed
/// A certificate component, its associated data, and useful methods.
///
-/// [`Cert::userids`], [`Cert::primary_userid`], [`Cert::user_attributes`], and
+/// [`Cert::userids`], [`ValidCert::primary_userid`], [`Cert::user_attributes`], and
/// [`Cert::unknowns`] return `ComponentAmalgamation`s.
///
/// `ComponentAmalgamation` implements [`ValidateAmalgamation`], which
@@ -683,7 +683,7 @@ pub trait ValidAmalgamation<'a, C: 'a>: seal::Sealed
///
/// [`Cert`]: super::Cert
/// [`Cert::userids`]: super::Cert::userids()
-/// [`Cert::primary_userid`]: super::Cert::primary_userid()
+/// [`ValidCert::primary_userid`]: super::ValidCert::primary_userid()
/// [`Cert::user_attributes`]: super::Cert::user_attributes()
/// [`Cert::unknowns`]: super::Cert::unknowns()
/// [`ComponentAmalgamation::with_policy`]: ValidateAmalgamation::with_policy()
diff --git a/openpgp/src/packet/key.rs b/openpgp/src/packet/key.rs
index c00d8496..a8770b7d 100644
--- a/openpgp/src/packet/key.rs
+++ b/openpgp/src/packet/key.rs
@@ -21,7 +21,7 @@
//! all represented by the `Key` enum and the `Key4` struct using
//! marker types. We use marker types rather than an enum, to better
//! exploit the type checking. For instance, type-specific methods
-//! like [`Key::secret`] are only exposed for those types that
+//! like [`Key4::secret`] are only exposed for those types that
//! actually support them. See the documentation for [`Key`] for an
//! explanation of how the markers work.
//!
@@ -40,7 +40,6 @@
//! [secret keys]: https://tools.ietf.org/html/rfc4880#section-5.5.1.3
//! [public subkeys]: https://tools.ietf.org/html/rfc4880#section-5.5.1.2
//! [secret subkeys]: https://tools.ietf.org/html/rfc4880#section-5.5.1.4
-//! [`Key::secret`]: super::Key::secret()
//! [`Key::decrypt_secret`]: super::Key::decrypt_secret()
//!
//! # Key Creation
diff --git a/openpgp/src/packet/signature.rs b/openpgp/src/packet/signature.rs
index a271962b..3dcc711c 100644
--- a/openpgp/src/packet/signature.rs
+++ b/openpgp/src/packet/signature.rs
@@ -1775,11 +1775,10 @@ impl PartialEq for Signature4 {
/// valid signatures, add subpackets to the unhashed area,
/// yielding valid but distinct signatures. If you want to ignore
/// the unhashed area, you should instead use the
- /// [`Signature4::normalized_eq`] method.
+ /// [`Signature::normalized_eq`] method.
///
/// [`level`]: Signature4::level()
/// [`computed_digest`]: Signature4::computed_digest()
- /// [`Signature4::normalized_eq`]: Signature4::normalized_eq()
fn eq(&self, other: &Signature4) -> bool {
self.cmp(other) == Ordering::Equal
}
diff --git a/openpgp/src/packet/signature/subpacket.rs b/openpgp/src/packet/signature/subpacket.rs
index 5af382b6..c1f7c510 100644
--- a/openpgp/src/packet/signature/subpacket.rs
+++ b/openpgp/src/packet/signature/subpacket.rs
@@ -3842,11 +3842,11 @@ impl signature::SignatureBuilder {
/// If you are only interested in modifying an existing
/// signature's unhashed area, it may be better to simply modify
/// the signature in place using
- /// [`Signature4::modify_unhashed_area`] rather than to create a
+ /// [`SignatureBuilder::modify_unhashed_area`] rather than to create a
/// new signature, because modifying the unhashed area doesn't
/// invalidate any existing signature.
///
- /// [`Signature4::modify_unhashed_area`]: Signature4::modify_unhashed_area()
+ /// [`SignatureBuilder::modify_unhashed_area`]: super::SignatureBuilder::modify_unhashed_area
///
/// # Examples
///
diff --git a/openpgp/src/parse/map.rs b/openpgp/src/parse/map.rs
index 17f2b2d6..b460deea 100644
--- a/openpgp/src/parse/map.rs
+++ b/openpgp/src/parse/map.rs
@@ -101,9 +101,9 @@ impl Map {
/// (e.g. "CTB", or "version"), an [`offset`] into the packet, and the
/// read [`data`].
///
-/// [`name`]: Field::name()
-/// [`offset`]: Field::offset()
-/// [`data`]: Field::data()
+/// [`name`]: Field::name
+/// [`offset`]: Field::offset
+/// [`data`]: Field::as_bytes
#[derive(Clone, Debug)]
pub struct Field<'a> {
/// Name of the field.
diff --git a/openpgp/src/regex/mod.rs b/openpgp/src/regex/mod.rs
index 1aba3be3..a7e911de 100644
--- a/openpgp/src/regex/mod.rs
+++ b/openpgp/src/regex/mod.rs
@@ -68,12 +68,12 @@
//! [`SignatureBuilder::add_regular_expression`].
//!
//! To extract any regular expressions, you can use
-//! [`SignatureBuilder::regular_expressions`].
+//! [`SubpacketAreas::regular_expressions`].
//!
//! [Regular Expression subpacket]: https://tools.ietf.org/html/rfc4880#section-5.2.3.14
//! [`SignatureBuilder::set_regular_expression`]: crate::packet::signature::SignatureBuilder::set_regular_expression()
//! [`SignatureBuilder::add_regular_expression`]: crate::packet::signature::SignatureBuilder::add_regular_expression()
-//! [`SignatureBuilder::regular_expressions`]: crate::packet::signature::SignatureBuilder::regular_expressions()
+//! [`SubpacketAreas::regular_expressions`]: crate::packet::signature::subpacket::SubpacketAreas::regular_expressions()
//!
//! # Caveat Emptor
//!
diff --git a/openpgp/src/types/revocation_key.rs b/openpgp/src/types/revocation_key.rs
index f3f2b10e..b1e759cf 100644
--- a/openpgp/src/types/revocation_key.rs
+++ b/openpgp/src/types/revocation_key.rs
@@ -17,10 +17,10 @@ use crate::{
///
/// [Section 5.2.3.15 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-5.2.3.15
///
-/// Revocation keys can be retrieved using [`ComponentAmalgamation::revocation_keys`]
+/// Revocation keys can be retrieved using [`ValidAmalgamation::revocation_keys`]
/// and set using [`CertBuilder::set_revocation_keys`].
///
-/// [`ComponentAmalgamation::revocation_keys`]: crate::cert::amalgamation::ComponentAmalgamation::revocation_keys()
+/// [`ValidAmalgamation::revocation_keys`]: crate::cert::amalgamation::ValidAmalgamation::revocation_keys()
/// [`CertBuilder::set_revocation_keys`]: crate::cert::CertBuilder::set_revocation_keys()
///
/// # Examples
diff --git a/openpgp/src/types/timestamp.rs b/openpgp/src/types/timestamp.rs
index 0691a927..148138fa 100644
--- a/openpgp/src/types/timestamp.rs
+++ b/openpgp/src/types/timestamp.rs
@@ -26,9 +26,9 @@ use crate::{
/// Signature creation time is internally stored as a `Timestamp`:
///
/// Note that this example retrieves raw packet value.
-/// Use [`SubpacketArea::signature_creation_time`] to get the signature creation time.
+/// Use [`SubpacketAreas::signature_creation_time`] to get the signature creation time.
///
-/// [`SubpacketArea::signature_creation_time`]: crate::packet::signature::subpacket::SubpacketArea::signature_creation_time()
+/// [`SubpacketAreas::signature_creation_time`]: crate::packet::signature::subpacket::SubpacketAreas::signature_creation_time()
///
/// ```
/// use sequoia_openpgp as openpgp;