Incorporate README.md into rustdoc where it wasn't already

The `cipher`, `crypto-common`, and `digest` crates didn't yet do this

Author: tarcieri

Cargo.lock

@@ -22,7 +22,6 @@ cast_possible_wrap = "warn"
 cast_precision_loss = "warn"
 cast_sign_loss = "warn"
 checked_conversions = "warn"
-doc_markdown = "warn"
 from_iter_instead_of_collect = "warn"
 implicit_saturating_sub = "warn"
 manual_assert = "warn"

Cargo.toml

@@ -7,7 +7,8 @@
 [![Project Chat][chat-image]][chat-link]
 [![Build Status][build-image]][build-link]
 
-Traits which define the functionality of [block ciphers] and [stream ciphers].
+Traits which define the functionality of [block ciphers], [block modes] and
+[stream ciphers].
 
 See [RustCrypto/block-ciphers] and [RustCrypto/stream-ciphers] for algorithm
 implementations which use these traits.
@@ -48,6 +49,7 @@ dual licensed as above, without any additional terms or conditions.
 [//]: # (general links)
 
 [block ciphers]: https://en.wikipedia.org/wiki/Block_cipher
+[block modes]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation
 [stream ciphers]: https://en.wikipedia.org/wiki/Stream_cipher
 [RustCrypto/block-ciphers]: https://github.com/RustCrypto/block-ciphers
 [RustCrypto/stream-ciphers]: https://github.com/RustCrypto/stream-ciphers

cipher/README.md

@@ -1,12 +1,6 @@
-//! This crate defines a set of traits which describe the functionality of
-//! [block ciphers][1], [block modes][2], and [stream ciphers][3].
-//!
-//! [1]: https://en.wikipedia.org/wiki/Block_cipher
-//! [2]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation
-//! [3]: https://en.wikipedia.org/wiki/Stream_cipher
-
 #![no_std]
 #![cfg_attr(docsrs, feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
     html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"

cipher/src/lib.rs

@@ -1,13 +1,11 @@
-//! Common cryptographic traits.
-
 #![no_std]
 #![cfg_attr(docsrs, feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
     html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
 )]
 #![forbid(unsafe_code)]
-#![warn(missing_docs, rust_2018_idioms, missing_debug_implementations)]
 
 /// Hazardous materials.
 pub mod hazmat;

crypto-common/src/lib.rs

@@ -22,6 +22,9 @@ blobby = { version = "0.4", optional = true }
 const-oid = { version = "0.10", optional = true }
 zeroize = { version = "1.7", optional = true, default-features = false }
 
+[dev-dependencies]
+sha2 = "0.11.0-rc.5"
+
 [features]
 default = ["block-api"]
 block-api = ["block-buffer"] # Enable block API traits

digest/Cargo.toml

@@ -39,7 +39,7 @@ hasher.update(data);
 hasher.update("String data");
 // Note that calling `finalize()` consumes hasher
 let hash = hasher.finalize();
-println!("Result: {:x}", hash);
+println!("Result: {:?}", hash);
 ```
 
 In this example `hash` has type [`Array<u8, U32>`][2], which is a generic
@@ -49,19 +49,23 @@ Alternatively you can use chained approach, which is equivalent to the previous
 example:
 
 ```rust
+use sha2::{Sha256, Digest};
+
 let hash = Sha256::new()
     .chain_update(b"Hello world!")
     .chain_update("String data")
     .finalize();
 
-println!("Result: {:x}", hash);
+println!("Result: {:?}", hash);
 ```
 
 If the whole message is available you also can use convenience `digest` method:
 
 ```rust
+use sha2::{Sha256, Digest};
+
 let hash = Sha256::digest(b"my message");
-println!("Result: {:x}", hash);
+println!("Result: {:?}", hash);
 ```
 
 ### Generic code

digest/README.md

@@ -1,7 +1,16 @@
-//! This crate provides traits which describe functionality of cryptographic hash
-//! functions and Message Authentication algorithms.
+#![no_std]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![doc = include_str!("../README.md")]
+#![forbid(unsafe_code)]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
+    html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
+)]
+#![warn(missing_docs, rust_2018_idioms, missing_debug_implementations)]
+
+//! ## Structure
 //!
-//! Traits in this repository are organized into the following levels:
+//! Traits in this crate are organized into the following levels:
 //!
 //! - **High-level convenience traits**: [`Digest`], [`DynDigest`], [`Mac`].
 //!   Wrappers around lower-level traits for most common use-cases. Users should
@@ -24,15 +33,6 @@
 //!
 //! [`digest-io`]: https://docs.rs/digest-io
 
-#![no_std]
-#![cfg_attr(docsrs, feature(doc_cfg))]
-#![forbid(unsafe_code)]
-#![doc(
-    html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
-    html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
-)]
-#![warn(missing_docs, rust_2018_idioms, missing_debug_implementations)]
-
 #[cfg(feature = "alloc")]
 #[macro_use]
 extern crate alloc;

digest/src/lib.rs

@@ -1,10 +1,10 @@
 #![no_std]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![doc = include_str!("../README.md")]
 #![doc(
     html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg",
     html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg"
 )]
-#![cfg_attr(docsrs, feature(doc_cfg))]
 #![forbid(unsafe_code)]
 #![allow(async_fn_in_trait)]
 #![warn(