diff options
| author | Justus Winter <justus@sequoia-pgp.org> | 2021-08-26 13:13:10 +0200 |
|---|---|---|
| committer | Justus Winter <justus@sequoia-pgp.org> | 2021-08-26 13:13:10 +0200 |
| commit | fff2b9169d413253cdf29b33227819b3256281f5 (patch) | |
| tree | 34202c7ed04c52d7266aff2d7ecb00591d332ccf /ipc | |
| parent | 31b4b189a5b23f570e3e5b712031a688d5c0633f (diff) | |
ipc: Update documentation.
Diffstat (limited to 'ipc')
| -rw-r--r-- | ipc/README.md | 4 | ||||
| -rw-r--r-- | ipc/src/keybox.rs | 2 | ||||
| -rw-r--r-- | ipc/src/lib.rs | 14 |
3 files changed, 8 insertions, 12 deletions
diff --git a/ipc/README.md b/ipc/README.md index d1820a87..c8c9c246 100644 --- a/ipc/README.md +++ b/ipc/README.md @@ -1,2 +1,2 @@ -Sequoia uses this to communicate with backend servers. This is an -implementation detail. Do not use this crate. +This crate implements IPC mechanisms to communicate with Sequoia and +GnuPG background services. diff --git a/ipc/src/keybox.rs b/ipc/src/keybox.rs index f6308bba..7ed481b7 100644 --- a/ipc/src/keybox.rs +++ b/ipc/src/keybox.rs @@ -233,7 +233,7 @@ impl HeaderRecord { } } -/// Kybox X.509 record +/// Keybox X.509 record /// /// Unhandled, only exists for completeness. #[derive(PartialEq, Eq, Debug)] diff --git a/ipc/src/lib.rs b/ipc/src/lib.rs index a212d5a8..7c1f7e90 100644 --- a/ipc/src/lib.rs +++ b/ipc/src/lib.rs @@ -1,4 +1,7 @@ -//! Low-level IPC mechanism for Sequoia. +//! IPC mechanisms for Sequoia. +//! +//! This crate implements IPC mechanisms to communicate with Sequoia +//! and GnuPG background services. //! //! # Rationale //! @@ -27,14 +30,7 @@ //! also means that we do not spawn a thread in your process, which is //! frowned upon for various reasons. //! -//! Please see [IPCPolicy] for more information. -//! -//! [IPCPolicy]: ../../sequoia_core/enum.IPCPolicy.html -//! -//! # Note -//! -//! Windows support is currently not implemented, but should be -//! straight forward. +//! Please see [`IPCPolicy`] for more information. #![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")] #![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")] |