summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWiktor Kwapisiewicz <wiktor@metacode.biz>2022-02-15 12:56:45 +0100
committerWiktor Kwapisiewicz <wiktor@metacode.biz>2022-02-15 13:47:31 +0100
commitecc2a152f1c415c2bc25c1cbe4ff45502a021ca0 (patch)
treea393d60ba5d5a3cb9c467ef35e888461aa48cd77
parentf7e3e6fbb693add25401b792c495f4a35adacd55 (diff)
ci: Deny missing or broken documentation.deny-missing-docs
- Add deny missing_docs to .cargo/config.toml, - Also add deny broken_intra_doc_links check, - Allow missing docs in "sq" and build scripts.
-rw-r--r--.cargo/config.toml2
-rw-r--r--autocrypt/src/lib.rs1
-rw-r--r--buffered-reader/src/lib.rs1
-rw-r--r--guide/build.rs2
-rw-r--r--guide/src/lib.rs1
-rw-r--r--ipc/build.rs2
-rw-r--r--ipc/src/core.rs2
-rw-r--r--ipc/src/gnupg.rs2
-rw-r--r--ipc/src/lib.rs1
-rw-r--r--net/src/lib.rs1
-rw-r--r--openpgp/build.rs2
-rw-r--r--openpgp/src/lib.rs1
-rw-r--r--sq/build.rs2
-rw-r--r--sq/src/sq-usage.rs2
14 files changed, 12 insertions, 10 deletions
diff --git a/.cargo/config.toml b/.cargo/config.toml
index d6533ecf..2575224c 100644
--- a/.cargo/config.toml
+++ b/.cargo/config.toml
@@ -3,6 +3,8 @@
# ignored.
rustflags = [
"-Dwarnings",
+ "-Dmissing_docs",
+ "-Drustdoc::broken_intra_doc_links",
"-Aunused-parens",
"-Aclippy::collapsible-else-if",
"-Aclippy::needless-question-mark",
diff --git a/autocrypt/src/lib.rs b/autocrypt/src/lib.rs
index fb76df9f..e5a4b92a 100644
--- a/autocrypt/src/lib.rs
+++ b/autocrypt/src/lib.rs
@@ -11,7 +11,6 @@
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
-#![warn(missing_docs)]
use std::convert::TryFrom;
use std::io;
diff --git a/buffered-reader/src/lib.rs b/buffered-reader/src/lib.rs
index 28f63a62..8dee1947 100644
--- a/buffered-reader/src/lib.rs
+++ b/buffered-reader/src/lib.rs
@@ -225,7 +225,6 @@
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
-#![warn(missing_docs)]
use std::io;
use std::io::{Error, ErrorKind};
diff --git a/guide/build.rs b/guide/build.rs
index c54213df..bcc94d38 100644
--- a/guide/build.rs
+++ b/guide/build.rs
@@ -1,3 +1,5 @@
+#![allow(missing_docs)]
+
use std::env;
use std::io::{self, Write, BufRead};
use std::fs::{self, DirEntry};
diff --git a/guide/src/lib.rs b/guide/src/lib.rs
index 3956dd91..08fdb9ca 100644
--- a/guide/src/lib.rs
+++ b/guide/src/lib.rs
@@ -21,6 +21,5 @@ Happy climbing!
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
-#![warn(missing_docs)]
include!(concat!(env!("OUT_DIR"), "/src/lib.rs"));
diff --git a/ipc/build.rs b/ipc/build.rs
index b8977c53..36c55047 100644
--- a/ipc/build.rs
+++ b/ipc/build.rs
@@ -1,3 +1,5 @@
+#![allow(missing_docs)]
+
use std::env;
use std::fs;
use std::io::{self, Write};
diff --git a/ipc/src/core.rs b/ipc/src/core.rs
index 6712921b..c6e949cf 100644
--- a/ipc/src/core.rs
+++ b/ipc/src/core.rs
@@ -17,8 +17,6 @@
//! # }
//! ```
-#![warn(missing_docs)]
-
use std::path::{Path, PathBuf};
use crate::Result;
diff --git a/ipc/src/gnupg.rs b/ipc/src/gnupg.rs
index 8fb2c490..527a2969 100644
--- a/ipc/src/gnupg.rs
+++ b/ipc/src/gnupg.rs
@@ -1,7 +1,5 @@
//! GnuPG RPC support.
-#![warn(missing_docs)]
-
use std::collections::BTreeMap;
use std::convert::TryFrom;
use std::ffi::OsStr;
diff --git a/ipc/src/lib.rs b/ipc/src/lib.rs
index f6f2525a..c07e549a 100644
--- a/ipc/src/lib.rs
+++ b/ipc/src/lib.rs
@@ -34,7 +34,6 @@
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
-#![warn(missing_docs)]
use std::fs;
use std::io::{self, Read, Write};
diff --git a/net/src/lib.rs b/net/src/lib.rs
index 39fc2d71..d0a8f073 100644
--- a/net/src/lib.rs
+++ b/net/src/lib.rs
@@ -36,7 +36,6 @@
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
-#![warn(missing_docs)]
use hyper::client::{ResponseFuture, HttpConnector};
use hyper::header::{CONTENT_LENGTH, CONTENT_TYPE, HeaderValue};
diff --git a/openpgp/build.rs b/openpgp/build.rs
index aabf157d..89b126d8 100644
--- a/openpgp/build.rs
+++ b/openpgp/build.rs
@@ -1,3 +1,5 @@
+#![allow(missing_docs)]
+
use std::env;
use std::fs;
use std::io::{self, Write};
diff --git a/openpgp/src/lib.rs b/openpgp/src/lib.rs
index 11878174..e024bd6e 100644
--- a/openpgp/src/lib.rs
+++ b/openpgp/src/lib.rs
@@ -48,7 +48,6 @@
#![doc(html_favicon_url = "https://docs.sequoia-pgp.org/favicon.png")]
#![doc(html_logo_url = "https://docs.sequoia-pgp.org/logo.svg")]
-#![warn(missing_docs)]
#[cfg(test)]
#[macro_use]
diff --git a/sq/build.rs b/sq/build.rs
index c1ce2954..57e7c08d 100644
--- a/sq/build.rs
+++ b/sq/build.rs
@@ -1,3 +1,5 @@
+#![allow(missing_docs)]
+
use std::env;
use std::fs;
use std::io::{self, Write};
diff --git a/sq/src/sq-usage.rs b/sq/src/sq-usage.rs
index 6ec1be5e..9673ce89 100644
--- a/sq/src/sq-usage.rs
+++ b/sq/src/sq-usage.rs
@@ -1,3 +1,5 @@
+#![allow(missing_docs)]
+
//! A command-line frontend for Sequoia.
//!
//! # Usage