diff options
author | Nora Widdecke <nora@sequoia-pgp.org> | 2021-08-25 17:16:59 +0200 |
---|---|---|
committer | Nora Widdecke <nora@sequoia-pgp.org> | 2021-08-27 12:58:07 +0200 |
commit | bc3a911e4e2009615704b9302b28ff09bcf4c2b7 (patch) | |
tree | 77496c61b0a12bbe82c3599dee179fc5a807c5da | |
parent | a7ffba7e699b5e841dc35104278877da39e9ba22 (diff) |
ffi, openpgp-ffi, ffi-macros: Correct links.
- Some link targets have moved or were replaced since the link's
creation. Make them point to the new location or replacement.
-rw-r--r-- | ffi-macros/src/lib.rs | 4 | ||||
-rw-r--r-- | ffi/src/store.rs | 2 | ||||
-rw-r--r-- | openpgp-ffi/src/amalgamation.rs | 15 | ||||
-rw-r--r-- | openpgp-ffi/src/error.rs | 2 | ||||
-rw-r--r-- | openpgp-ffi/src/key_amalgamation.rs | 12 | ||||
-rw-r--r-- | openpgp-ffi/src/lib.rs | 8 |
6 files changed, 15 insertions, 28 deletions
diff --git a/ffi-macros/src/lib.rs b/ffi-macros/src/lib.rs index a1088110..992581ee 100644 --- a/ffi-macros/src/lib.rs +++ b/ffi-macros/src/lib.rs @@ -25,8 +25,8 @@ mod rust2c; /// This macro is used to decorate every function exported from /// Sequoia. It applies the following transformations: /// -/// - [ffi_catch_abort] -/// - [cdecl] +/// - [ffi_catch_abort()] +/// - [cdecl()] #[proc_macro_attribute] pub fn extern_fn(attr: TokenStream, item: TokenStream) -> TokenStream { cdecl(attr.clone(), ffi_catch_abort(attr, item)) diff --git a/ffi/src/store.rs b/ffi/src/store.rs index 9c32cf4d..806c386b 100644 --- a/ffi/src/store.rs +++ b/ffi/src/store.rs @@ -14,7 +14,7 @@ //! Sequoia updates keys in compliance with the [network policy] used //! to create the store. //! -//! [network policy]: super::super::sequoia_core::NetworkPolicy +//! [network policy]: sequoia_net::Policy //! //! # Examples //! diff --git a/openpgp-ffi/src/amalgamation.rs b/openpgp-ffi/src/amalgamation.rs index 697eff79..99c68a26 100644 --- a/openpgp-ffi/src/amalgamation.rs +++ b/openpgp-ffi/src/amalgamation.rs @@ -1,9 +1,8 @@ -//! `KeyAmalgamation`s. +//! `UserIDAmalgamation`s. //! //! -//! Wraps [`sequoia-openpgp::cert::key_amalgamation::KeyAmalgamation`]. -//! -//! [`sequoia-openpgp::cert::key_amalgamation::KeyAmalgamation`]: sequoia_openpgp::cert::key_amalgamation::KeyAmalgamation +//! Wraps [`sequoia_openpgp::cert::amalgamation::UserIDAmalgamation`] and +//! [`sequoia_openpgp::cert::amalgamation::ValidUserIDAmalgamation`]. use libc::time_t; @@ -30,9 +29,7 @@ type UserIDAmalgamationType<'a> /// A `UserIDAmalgamation` holds a `UserID` and associated data. /// -/// Wraps [`sequoia-openpgp::cert::amalgamation::ComponentAmalgamation`]. -/// -/// [`sequoia-openpgp::cert::amalgamation::ComponentAmalgamation`]: sequoia_openpgp::cert::amalgamation::ComponentAmalgamation +/// Wraps [`sequoia_openpgp::cert::amalgamation::UserIDAmalgamation`]. #[crate::ffi_wrapper_type(prefix = "pgp_", derive = "Clone, Debug")] pub struct UserIDAmalgamation<'a>(UserIDAmalgamationType<'a>); @@ -54,9 +51,7 @@ type ValidUserIDAmalgamationType<'a> /// A `ValidUserIDAmalgamation` holds a `UserID` and associated data /// including a policy and a reference time. /// -/// Wraps [`sequoia-openpgp::cert::amalgamation::ValidComponentAmalgamation`]. -/// -/// [`sequoia-openpgp::cert::amalgamation::ValidComponentAmalgamation`]: sequoia_openpgp::cert::amalgamation::ValidComponentAmalgamation +/// Wraps [`sequoia_openpgp::cert::amalgamation::ValidUserIDAmalgamation`]. #[crate::ffi_wrapper_type(prefix = "pgp_", derive = "Clone, Debug")] pub struct ValidUserIDAmalgamation<'a>(ValidUserIDAmalgamationType<'a>); diff --git a/openpgp-ffi/src/error.rs b/openpgp-ffi/src/error.rs index bb10c89c..04bb05c0 100644 --- a/openpgp-ffi/src/error.rs +++ b/openpgp-ffi/src/error.rs @@ -11,8 +11,6 @@ use crate::RefRaw; /// Complex errors. /// /// This wraps [`anyhow::Error`]s. -/// -/// [`anyhow::Error`]: failure::Error #[crate::ffi_wrapper_type(prefix = "pgp_", derive = "Display")] pub struct Error(anyhow::Error); diff --git a/openpgp-ffi/src/key_amalgamation.rs b/openpgp-ffi/src/key_amalgamation.rs index 94ffcb39..d2688d09 100644 --- a/openpgp-ffi/src/key_amalgamation.rs +++ b/openpgp-ffi/src/key_amalgamation.rs @@ -1,9 +1,7 @@ //! `KeyAmalgamation`s. //! //! -//! Wraps [`sequoia-openpgp::cert::key_amalgamation::KeyAmalgamation`]. -//! -//! [`sequoia-openpgp::cert::key_amalgamation::KeyAmalgamation`]: sequoia_openpgp::cert::key_amalgamation::KeyAmalgamation +//! Wraps [`sequoia_openpgp::cert::amalgamation::key::KeyAmalgamation`]. use std::slice; use libc::{size_t, time_t}; @@ -33,9 +31,7 @@ type ErasedKeyAmalgamation<'a> = /// A `KeyAmalgamation` holds a `Key` and associated data. /// -/// Wraps [`sequoia-openpgp::cert::key_amalgamation::KeyAmalgamation`]. -/// -/// [`sequoia-openpgp::cert::key_amalgamation::KeyAmalgamation`]: sequoia_openpgp::cert::key_amalgamation::KeyAmalgamation +/// Wraps [`sequoia_openpgp::cert::amalgamation::key::KeyAmalgamation`]. #[crate::ffi_wrapper_type(prefix = "pgp_", derive = "Clone, Debug")] pub struct KeyAmalgamation<'a>(ErasedKeyAmalgamation<'a>); @@ -58,9 +54,7 @@ pub extern "C" fn pgp_key_amalgamation_key<'a>(ka: *const KeyAmalgamation<'a>) /// A `ValidKeyAmalgamation` holds a `Key` and associated data /// including a policy and a reference time. /// -/// Wraps [`sequoia-openpgp::cert::key_amalgamation::ValidKeyAmalgamation`]. -/// -/// [`sequoia-openpgp::cert::key_amalgamation::ValidKeyAmalgamation`]: sequoia_openpgp::cert::key_amalgamation::ValidKeyAmalgamation +/// Wraps [`sequoia_openpgp::cert::amalgamation::key::ValidKeyAmalgamation`]. #[crate::ffi_wrapper_type(prefix = "pgp_", derive = "Clone, Debug")] pub struct ValidKeyAmalgamation<'a>(ValidErasedKeyAmalgamation<'a>); diff --git a/openpgp-ffi/src/lib.rs b/openpgp-ffi/src/lib.rs index b0b2142e..3f8f5e77 100644 --- a/openpgp-ffi/src/lib.rs +++ b/openpgp-ffi/src/lib.rs @@ -129,23 +129,23 @@ //! //! Functions that cannot fail are a nice consequence of the //! 'fail-fast on undefined behavior'-rule. An example of such -//! function is [`pgp_fingerprint_to_string`]. This function cannot +//! function is [`Fingerprint::to_string`]. This function cannot //! fail, unless either the given fingerprint reference is invalid, //! or the allocation for the string failed, which is considered //! undefined behavior. //! -//! [`pgp_fingerprint_to_string`]: fingerprint::Fingerprint::pgp_fingerprint_to_string() +//! [`Fingerprint::to_string`]: sequoia-openpgp::Fingerprint::to_string() //! //! Failing functions signal failure either in-band (e.g. `NULL`, or //! -1), using `pgp_status_t`, and may store complex error information //! in a caller-provided location. For example, constructors often //! return `NULL` to signal errors. An example of a constructor that //! may fail and return `NULL`, but does not communicate complex error -//! is [`pgp_fingerprint_from_hex`]. [`pgp_packet_parser_from_bytes`], +//! is [`Fingerprint::from_hex`]. [`pgp_packet_parser_from_bytes`], //! on the other hand, will return `NULL` and store a complex error at //! the location given using the `errp` parameter. //! -//! [`pgp_fingerprint_from_hex`]: fingerprint::Fingerprint::pgp_fingerprint_from_hex() +//! [`Fingerprint::from_hex`]: sequoia-openpgp::Fingerprint::from_hex() //! [`pgp_packet_parser_from_bytes`]: parse::pgp_packet_parser_from_bytes() //! //! Errors may be inspected using [`pgp_error_status`], and formatted |