diff options
author | Nora Widdecke <nora@sequoia-pgp.org> | 2021-08-23 16:55:26 +0200 |
---|---|---|
committer | Nora Widdecke <nora@sequoia-pgp.org> | 2021-08-27 12:58:07 +0200 |
commit | e5746684e84377dd8828f6a5a8ab4c0eec73c3ec (patch) | |
tree | 5261ba9f497ec5ce51d47198742919673de3c893 | |
parent | 078c4d7ee16ea06977ec8cb7cf5571c880e9c710 (diff) |
Convert markdown to intra-doc links.
- Apply cargo intraconv.
87 files changed, 996 insertions, 1254 deletions
diff --git a/buffered-reader/src/generic.rs b/buffered-reader/src/generic.rs index aa72e1b4..eed96d5e 100644 --- a/buffered-reader/src/generic.rs +++ b/buffered-reader/src/generic.rs @@ -11,8 +11,6 @@ use super::*; /// read from a file, use [`File`]. To read from a buffer, use /// [`Memory`]. Both are more efficient than `Generic`. /// -/// [`File`]: struct.File.html -/// [`Memory`]: struct.Memory.html pub struct Generic<T: io::Read + Send + Sync, C: fmt::Debug + Sync + Send> { buffer: Option<Box<[u8]>>, // The next byte to read in the buffer. diff --git a/buffered-reader/src/lib.rs b/buffered-reader/src/lib.rs index ed5a4724..918b7268 100644 --- a/buffered-reader/src/lib.rs +++ b/buffered-reader/src/lib.rs @@ -219,8 +219,8 @@ //! general-purpose parsers, like the `Zip` //! decompressor. //! -//! [`BufRead`]: https://doc.rust-lang.org/stable/std/io/trait.BufRead.html -//! [`BufReader`]: https://doc.rust-lang.org/stable/std/io/struct.BufReader.html +//! [`BufRead`]: std::io::BufRead +//! [`BufReader`]: std::io::BufReader //! [HTTP's chunk transfer encoding]: https://en.wikipedia.org/wiki/Chunked_transfer_encoding #![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")] @@ -603,7 +603,6 @@ pub trait BufferedReader<C> : io::Read + fmt::Debug + fmt::Display + Send + Sync /// iff the end of the stream is reached, but the reader is not /// consummated. /// - /// [`Limitor`]: struct.Limitor.html fn consummated(&mut self) -> bool { self.eof() } diff --git a/ffi-macros/src/lib.rs b/ffi-macros/src/lib.rs index 29a49d85..a1088110 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](attr.ffi_catch_abort.html) -/// - [cdecl](attr.cdecl.html) +/// - [ffi_catch_abort] +/// - [cdecl] #[proc_macro_attribute] pub fn extern_fn(attr: TokenStream, item: TokenStream) -> TokenStream { cdecl(attr.clone(), ffi_catch_abort(attr, item)) @@ -104,7 +104,7 @@ fn doc(s: &str, ts: &mut TokenStream2) { /// manner. /// /// [undefined behavior]: https://doc.rust-lang.org/nomicon/unwinding.html -/// [catch_unwind]: https://doc.rust-lang.org/std/panic/fn.catch_unwind.html +/// [catch_unwind]: std::panic::catch_unwind() /// /// # Examples /// diff --git a/ffi/src/lib.rs b/ffi/src/lib.rs index 1edf1493..40e3672e 100644 --- a/ffi/src/lib.rs +++ b/ffi/src/lib.rs @@ -38,12 +38,12 @@ //! use [`Box::into_raw(..)`]. From this moment on, ownership must be //! managed by the C application. //! -//! [`Box::into_raw(..)`]: https://doc.rust-lang.org/std/boxed/struct.Box.html#method.into_raw +//! [`Box::into_raw(..)`]: std::boxed::Box::into_raw() //! //! To transfer ownership from C to Rust, we re-create the box using //! [`Box::from_raw(..)`]. //! -//! [`Box::from_raw(..)`]: https://doc.rust-lang.org/std/boxed/struct.Box.html#method.from_raw +//! [`Box::from_raw(..)`]: std::boxed::Box::from_raw() //! //! In this crate we use a series of macros to transfer ownership from //! Rust to C. `fry_box` matches on `Result<T>`, handling errors by diff --git a/ffi/src/store.rs b/ffi/src/store.rs index e4082d5a..9c32cf4d 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]: ../../sequoia_core/enum.NetworkPolicy.html +//! [network policy]: super::super::sequoia_core::NetworkPolicy //! //! # Examples //! diff --git a/ipc/src/assuan/mod.rs b/ipc/src/assuan/mod.rs index a1337ed4..9f7ab824 100644 --- a/ipc/src/assuan/mod.rs +++ b/ipc/src/assuan/mod.rs @@ -41,16 +41,13 @@ lalrpop_util::lalrpop_mod!( /// command is sent lazily, i.e. it is only sent if you poll for the /// responses. /// -/// [`Connection::send`]: #method.send +/// [`Connection::send`]: Client::send() /// /// `Client` implements [`Stream`] to return all server responses /// until the first [`Response::Ok`], [`Response::Error`], or /// [`Response::Inquire`]. /// /// [`Stream`]: #impl-Stream -/// [`Response::Ok`]: enum.Response.html#variant.Ok -/// [`Response::Error`]: enum.Response.html#variant.Error -/// [`Response::Inquire`]: enum.Response.html#variant.Inquire /// /// [`Response::Ok`] and [`Response::Error`] indicate success and /// failure. [`Response::Inquire`] means that the server requires @@ -58,8 +55,8 @@ lalrpop_util::lalrpop_mod!( /// provided using [`Connection::data()`], or the operation may be /// canceled using [`Connection::cancel()`]. /// -/// [`Connection::data()`]: #method.data -/// [`Connection::cancel()`]: #method.cancel +/// [`Connection::data()`]: Client::data() +/// [`Connection::cancel()`]: Client::cancel() pub struct Client { r: BufReader<ReadHalf<IpcStream>>, // xxx: abstract over buffer: Vec<u8>, @@ -99,11 +96,11 @@ impl Client { /// [`Connection::data()`], or the operation may be canceled using /// [`Connection::cancel()`]. /// - /// [`Response::Ok`]: ../assuan/enum.Response.html#variant.Ok - /// [`Response::Error`]: ../assuan/enum.Response.html#variant.Error - |