docs: Extends #999. Remove disused package readmes. Rename to sr-metadata. Fix Readme Rustdoc names (#1016)

* docs: Remove safe-mix since is no longer local dependency

* docs: Fix existing packages link. Still only includes Substrate Core

* docs: Remove empty package Readmes. Remove old docs links. Rename to Readme

* docs: Remove link to old docs

* misc: Merge latest from master. Renaem to sr-metadata. Fix list of RustDoc package names

* Rename substrate-metadata to sr-metadata, since it is in the "srml" subdirectory

* Change example to use package name that opens all packages in RustDocs

* Fix list of packages names that are available to open in RustDocs

* fix typo

* fix ordering of CLI options and add missing backslash

substrate/srml/README.adoc

@@ -2,5 +2,3 @@
 = Runtime
 
 Set of libs for the substrate runtime.
-
-TODO: Add READMEs to packages.

substrate/srml/balances/src/lib.rs

@@ -14,7 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
-//! Balances: Handles balances.
+//! Balances: Handles setting and retrieval of free balance, 
+//! retrieving total balance, reserve and unreserve balance, 
+//! repatriating a reserved balance to a beneficiary account that exists,
+//! transfering a balance between accounts (when not reserved),
+//! slashing an account balance, account removal, rewards,
+//! lookup of an index to reclaim an account (when not balance not reserved),
+//! increasing total stake.
 
 #![cfg_attr(not(feature = "std"), no_std)]
 

substrate/srml/contract/README.md

@@ -1,3 +1,5 @@
+# Complexity
+
 This analysis is on the computing and memory complexity of specific procedures. It provides a rough estimate of operations performed in general and especially focusing on DB reads and writes. It is also an attempt to estimate the memory consumption at its peak.
 
 The primary goal is to come up with decent pricing for functions that can be invoked by a user (via extrinsics) or by untrusted code that prevents DoS attacks.

substrate/srml/metadata/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "substrate-metadata"
+name = "srml-metadata"
 version = "0.1.0"
 authors = ["Parity Technologies <admin@parity.io>"]
 

substrate/srml/metadata/README.adoc

@@ -1,13 +0,0 @@
-
-= Substrate BFT
-
-.Summary
-[source, toml]
-----
-include::Cargo.toml[lines=2..5]
-----
-
-.Description
-----
-include::src/lib.rs[tag=description]
-----

substrate/srml/support/Cargo.toml

@@ -8,7 +8,7 @@ hex-literal = { version = "0.1.0", optional = true }
 serde = { version = "1.0", default-features = false }
 serde_derive = { version = "1.0", optional = true }
 parity-codec = { version = "2.1", default-features = false }
-substrate-metadata = { path = "../metadata", default-features = false }
+srml-metadata = { path = "../metadata", default-features = false }
 sr-std = { path = "../../core/sr-std", default-features = false }
 sr-io = { path = "../../core/sr-io", default-features = false }
 sr-primitives = { path = "../../core/sr-primitives", default-features = false }
@@ -28,7 +28,7 @@ std = [
 	"parity-codec/std",
 	"sr-std/std",
 	"sr-primitives/std",
-	"substrate-metadata/std",
+	"srml-metadata/std",
 ]
 nightly = []
 strict = []

substrate/srml/support/README.adoc

@@ -1,14 +0,0 @@
-
-= Runtime Support
-
-.Summary
-[source, toml]
-----
-include::Cargo.toml[lines=2..5]
-----
-
-.Description
-----
-include::src/lib.rs[tag=description]
-----
-

substrate/srml/support/src/dispatch.rs

@@ -21,7 +21,7 @@ pub use rstd::prelude::{Vec, Clone, Eq, PartialEq};
 pub use std::fmt;
 pub use rstd::result;
 pub use codec::{Codec, Decode, Encode, Input, Output};
-pub use substrate_metadata::{
+pub use srml_metadata::{
 	ModuleMetadata, FunctionMetadata, DecodeDifferent,
 	CallMetadata, FunctionArgumentMetadata, OuterDispatchMetadata, OuterDispatchCall
 };

substrate/srml/support/src/event.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
-pub use substrate_metadata::{EventMetadata, DecodeDifferent, OuterEventMetadata, FnEncode};
+pub use srml_metadata::{EventMetadata, DecodeDifferent, OuterEventMetadata, FnEncode};
 
 /// Implement the `Event` for a module.
 ///

substrate/srml/support/src/lib.rs

@@ -14,9 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
-// tag::description[]
 //! Support code for the runtime.
-// end::description[]
 
 #![cfg_attr(not(feature = "std"), no_std)]
 #![cfg_attr(not(feature = "std"), feature(alloc))]
@@ -29,7 +27,7 @@ pub extern crate sr_std as rstd;
 extern crate sr_io as runtime_io;
 #[doc(hidden)]
 pub extern crate sr_primitives as runtime_primitives;
-extern crate substrate_metadata;
+extern crate srml_metadata;
 
 extern crate mashup;
 

substrate/srml/support/src/metadata.rs

@@ -14,7 +14,7 @@
 // You should have received a copy of the GNU General Public License
 // along with Substrate.  If not, see <http://www.gnu.org/licenses/>.
 
-pub use substrate_metadata::{
+pub use srml_metadata::{
 	DecodeDifferent, FnEncode, RuntimeMetadata, RuntimeModuleMetadata
 };
 
@@ -98,7 +98,7 @@ macro_rules! __runtime_modules_to_metadata {
 #[allow(dead_code)]
 mod tests {
 	use super::*;
-	use substrate_metadata::{
+	use srml_metadata::{
 		EventMetadata, OuterEventMetadata, RuntimeModuleMetadata, CallMetadata, ModuleMetadata,
 		StorageFunctionModifier, StorageFunctionType, FunctionMetadata,
 		StorageMetadata, StorageFunctionMetadata, OuterDispatchMetadata, OuterDispatchCall

substrate/srml/support/src/storage/generator.rs

@@ -53,7 +53,7 @@ pub use rstd::borrow::Borrow;
 #[doc(hidden)]
 pub use rstd::marker::PhantomData;
 
-pub use substrate_metadata::{
+pub use srml_metadata::{
 	DecodeDifferent, StorageMetadata, StorageFunctionMetadata,
 	StorageFunctionType, StorageFunctionModifier
 };

substrate/srml/timestamp/src/lib.rs

@@ -29,7 +29,6 @@
 //! ## Finalization
 //!
 //! This module should be hooked up to the finalization routine.
-//!
 
 #![cfg_attr(not(feature = "std"), no_std)]