docs: evmbin - Update Rust docs (#10658)

* docs: Update evmbin to use rustup instead of multirust * docs: Update evmbin with Rustdocs overview, usage, comments * review-fix: Simplify evmbin usage commands * docs: Update evmbin Overview typo Co-Authored-By: David <dvdplm@gmail.com> * docs: Update evmbin Overview grammer Co-Authored-By: David <dvdplm@gmail.com> * docs: Update evmbin Rust comments to be lowercase Co-Authored-By: David <dvdplm@gmail.com> * docs: Update evmbin Rust comments to be lowercase for gas price Co-Authored-By: David <dvdplm@gmail.com> * docs: Update evmbin build command Rust docs Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * review-fix: Update evmbin Overview to create release per dvdplm comment * review-fix: Fix explanation in usage section * review-fix: Update evmbin usage suggesting user to copy the executable to PATH or create symlink * review-fix: Update evmbin executable in path sentence * review-fix: Remove explaining to users how to use binaries since out of scope of docs
openethereum · May 21, 2019 · 8998774 · 8998774
1 parent c31ffab
commit 8998774
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/evmbin/benches/mod.rs b/evmbin/benches/mod.rs
@@ -17,7 +17,7 @@
 //! benchmarking for EVM
 //! should be started with:
 //! ```bash
-//! multirust run nightly cargo bench
+//! rustup run nightly cargo bench
 //! ```
 
 #![feature(test)]

diff --git a/evmbin/src/main.rs b/evmbin/src/main.rs
@@ -14,7 +14,23 @@
 // You should have received a copy of the GNU General Public License
 // along with Parity Ethereum.  If not, see <http://www.gnu.org/licenses/>.
 
-//! Parity EVM interpreter binary.
+//! Parity EVM Interpreter Binary.
+//!
+//! ## Overview
+//!
+//! The Parity EVM interpreter binary is a tool in the Parity
+//! Ethereum toolchain. It is an EVM implementation for Parity Ethereum that
+//! is used to run a standalone version of the EVM interpreter.
+//!
+//! ## Usage
+//!
+//! The evmbin tool is not distributed with regular Parity Ethereum releases
+//! so you need to build it from source and run it like so:
+//!
+//! ```bash
+//! cargo build -p evmbin --release
+//! ./target/release/parity-evm --help
+//! ```
 
 #![warn(missing_docs)]
 
@@ -268,13 +284,17 @@ struct Args {
 }
 
 impl Args {
+	/// Set the gas limit. Defaults to max value to allow code to run for whatever time is required.
 	pub fn gas(&self) -> Result<U256, String> {
 		match self.flag_gas {
 			Some(ref gas) => gas.parse().map_err(to_string),
 			None => Ok(U256::from(u64::max_value())),
 		}
 	}
 
+	/// Set the gas price. Defaults to zero to allow the code to run even if an account with no balance
+	/// is used, otherwise such accounts would not have sufficient funds to pay the transaction fee.
+	/// Defaulting to zero also makes testing easier since it is not necessary to specify a special configuration file.
 	pub fn gas_price(&self) -> Result<U256, String> {
 		match self.flag_gas_price {
 			Some(ref gas_price) => gas_price.parse().map_err(to_string),