Rename remaining occurences of SRML to FRAME (paritytech#4932)

* rename remaining SRML occurences to FRAME * Some module -> pallet * remove out of date url Co-authored-by: Shawn Tabrizi <[email protected]> Co-authored-by: Cecile Tonglet <[email protected]>
howazure · Feb 19, 2020 · 5a2824d · 5a2824d
1 parent c077a2b
commit 5a2824d
Show file tree

Hide file tree

Showing 35 changed files with 123 additions and 123 deletions.
diff --git a/bin/node-template/README.md b/bin/node-template/README.md
@@ -1,6 +1,6 @@
 # Substrate Node Template
 
-A new SRML-based Substrate node, ready for hacking.
+A new FRAME-based Substrate node, ready for hacking.
 
 ## Build
 

diff --git a/bin/node-template/pallets/template/src/lib.rs b/bin/node-template/pallets/template/src/lib.rs
@@ -1,12 +1,12 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 
-/// A runtime module template with necessary imports
+/// A FRAME pallet template with necessary imports
 
 /// Feel free to remove or edit this file as needed.
 /// If you change the name of this file, make sure to update its references in runtime/src/lib.rs
 /// If you remove this file, you can remove those references
 
-/// For more guidance on Substrate modules, see the example module
+/// For more guidance on Substrate FRAME, see the example pallet
 /// https://github.com/paritytech/substrate/blob/master/frame/example/src/lib.rs
 
 use frame_support::{decl_module, decl_storage, decl_event, decl_error, dispatch};

diff --git a/bin/node-template/pallets/template/src/mock.rs b/bin/node-template/pallets/template/src/mock.rs
@@ -11,9 +11,9 @@ impl_outer_origin! {
 	pub enum Origin for Test {}
 }
 
-// For testing the module, we construct most of a mock runtime. This means
+// For testing the pallet, we construct most of a mock runtime. This means
 // first constructing a configuration type (`Test`) which `impl`s each of the
-// configuration traits of modules we want to use.
+// configuration traits of pallets we want to use.
 #[derive(Clone, Eq, PartialEq)]
 pub struct Test;
 parameter_types! {

diff --git a/bin/node/rpc/src/lib.rs b/bin/node/rpc/src/lib.rs
@@ -23,9 +23,9 @@
 //! need some strong assumptions about the particular runtime.
 //!
 //! The RPCs available in this crate however can make some assumptions
-//! about how the runtime is constructed and what `SRML` modules
+//! about how the runtime is constructed and what FRAME pallets
 //! are part of it. Therefore all node-runtime-specific RPCs can
-//! be placed here or imported from corresponding `SRML` RPC definitions.
+//! be placed here or imported from corresponding FRAME RPC definitions.
 
 #![warn(missing_docs)]
 

diff --git a/bin/node/runtime/src/constants.rs b/bin/node/runtime/src/constants.rs
@@ -38,7 +38,7 @@ pub mod time {
 	/// a slot being empty).
 	/// This value is only used indirectly to define the unit constants below
 	/// that are expressed in blocks. The rest of the code should use
-	/// `SLOT_DURATION` instead (like the timestamp module for calculating the
+	/// `SLOT_DURATION` instead (like the Timestamp pallet for calculating the
 	/// minimum period).
 	///
 	/// If using BABE with secondary slots (default) then all of the slots will

diff --git a/docs/CONTRIBUTING.adoc b/docs/CONTRIBUTING.adoc
@@ -27,7 +27,7 @@ Merging pull requests once CI is successful:
 
 . Once a PR is ready for review please add the https://github.com/paritytech/substrate/pulls?q=is%3Apr+is%3Aopen+label%3AA0-pleasereview[`pleasereview`] label. Generally PRs should sit with this label for 48 hours in order to garner feedback. It may be merged before if all relevant parties had a look at it.
 . If the first review is not an approval, swap `A0-pleasereview` to any label `[A3, A7]` to indicate that the PR has received some feedback, but needs further work. For example. https://github.com/paritytech/substrate/labels/A3-inprogress[`A3-inprogress`] is a general indicator that the PR is work in progress and https://github.com/paritytech/substrate/labels/A4-gotissues[`A4-gotissues`] means that it has significant problems that need fixing. Once the work is done, change the label back to `A0-pleasereview`. You might end up swapping a few times back and forth to climb up the A label group. Once a PR is https://github.com/paritytech/substrate/labels/A8-looksgood[`A8-looksgood`], it is ready to merge. 
-. PRs that break the external API must be tagged with https://github.com/paritytech/substrate/labels/B2-breaksapi[`breaksapi`], when it changes the SRML or consensus of running system with https://github.com/paritytech/substrate/labels/B3-breaksconsensus[`breaksconsensus`]
+. PRs that break the external API must be tagged with https://github.com/paritytech/substrate/labels/B2-breaksapi[`breaksapi`], when it changes the FRAME or consensus of running system with https://github.com/paritytech/substrate/labels/B3-breaksconsensus[`breaksconsensus`]
 . No PR should be merged until all reviews' comments are addressed.
 
 *Reviewing pull requests*:

diff --git a/docs/README.adoc b/docs/README.adoc
@@ -26,7 +26,7 @@ Substrate is designed for use in one of three ways:
 
 **2. Modular**: By hacking together pallets built with Substrate FRAME into a new runtime and possibly altering or reconfiguring the Substrate client's block authoring logic. This affords you a very large amount of freedom over your blockchain's logic, letting you change data types, add or remove modules, and crucially, add your own modules. Much can be changed without touching the block authoring logic (since it is generic). If this is the case, then the existing Substrate binary can be used for block authoring and syncing. If the block authoring logic needs to be tweaked, then a new, altered block authoring binary must be built as a separate project and used by validators. This is how the Polkadot relay chain is built and should suffice for almost all circumstances in the near to mid-term.
 
-**3. Generic**: The entire SRML can be ignored and the entire runtime designed and implemented from scratch. If desired, this can be done in a language other than Rust, provided it can target WebAssembly. If the runtime can be made compatible with the existing client's block authoring logic, then you can simply construct a new genesis block from your Wasm blob and launch your chain with the existing Rust-based Substrate client. If not, then you'll need to alter the client's block authoring logic accordingly. This is probably a useless option for most projects right now, but provides complete flexibility allowing for a long-term, far-reaching upgrade path for the Substrate paradigm.
+**3. Generic**: The entire FRAME can be ignored and the entire runtime designed and implemented from scratch. If desired, this can be done in a language other than Rust, provided it can target WebAssembly. If the runtime can be made compatible with the existing client's block authoring logic, then you can simply construct a new genesis block from your Wasm blob and launch your chain with the existing Rust-based Substrate client. If not, then you'll need to alter the client's block authoring logic accordingly. This is probably a useless option for most projects right now, but provides complete flexibility allowing for a long-term, far-reaching upgrade path for the Substrate paradigm.
 
 === The Basics of Substrate
 

diff --git a/frame/assets/src/lib.rs b/frame/assets/src/lib.rs
@@ -265,9 +265,9 @@ mod tests {
 		pub enum Origin for Test  where system = frame_system {}
 	}
 
-	// For testing the module, we construct most of a mock runtime. This means
+	// For testing the pallet, we construct most of a mock runtime. This means
 	// first constructing a configuration type (`Test`) which `impl`s each of the
-	// configuration traits of modules we want to use.
+	// configuration traits of pallets we want to use.
 	#[derive(Clone, Eq, PartialEq)]
 	pub struct Test;
 	parameter_types! {

diff --git a/frame/authorship/Cargo.toml b/frame/authorship/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "pallet-authorship"
 version = "2.0.0"
-description = "Block and Uncle Author tracking for the SRML"
+description = "Block and Uncle Author tracking for the FRAME"
 authors = ["Parity Technologies <[email protected]>"]
 edition = "2018"
 license = "GPL-3.0"

diff --git a/frame/authorship/src/lib.rs b/frame/authorship/src/lib.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/>.
 
-//! Authorship tracking for SRML runtimes.
+//! Authorship tracking for FRAME runtimes.
 //!
 //! This tracks the current author of the block and recent uncles.
 

diff --git a/frame/babe/src/lib.rs b/frame/babe/src/lib.rs
@@ -159,7 +159,7 @@ decl_storage! {
 }
 
 decl_module! {
-	/// The BABE SRML module
+	/// The BABE Pallet
 	pub struct Module<T: Trait> for enum Call where origin: T::Origin {
 		/// The number of **slots** that an epoch takes. We couple sessions to
 		/// epochs, i.e. we start a new session once the new epoch begins.

diff --git a/frame/balances/src/lib.rs b/frame/balances/src/lib.rs
@@ -92,7 +92,7 @@
 //!
 //! The following examples show how to use the Balances module in your custom module.
 //!
-//! ### Examples from the SRML
+//! ### Examples from the FRAME
 //!
 //! The Contract module uses the `Currency` trait to handle gas payment, and its types inherit from `Currency`:
 //!
@@ -896,7 +896,7 @@ mod imbalances {
 // This works as long as `increase_total_issuance_by` doesn't use the Imbalance
 // types (basically for charging fees).
 // This should eventually be refactored so that the type item that
-// depends on the Imbalance type (DustRemoval) is placed in its own SRML module.
+// depends on the Imbalance type (DustRemoval) is placed in its own pallet.
 struct ElevatedTrait<T: Subtrait<I>, I: Instance>(T, I);
 impl<T: Subtrait<I>, I: Instance> Clone for ElevatedTrait<T, I> {
 	fn clone(&self) -> Self { unimplemented!() }