More document/script cleanup

doc/witness_parameters.md

@@ -1,6 +1,6 @@
 # Witness Parameters
 
-The role of a witness in the Hive Blockchain is to verify incoming transactions, produce blocks when scheduled, and partake in the Hive governance model by voting on several parameters.
+The role of a witness in the Hive blockchain network is to verify incoming transactions, produce blocks when scheduled, and partake in the Hive governance model by voting on several parameters.
 
 These parameters control various aspects of the operation of the blockchain that are not easily defined in code at compile time. One example is the HIVE price feed that defines the conversion rate between HIVE and HBD.
 

scripts/build.sh

@@ -10,19 +10,19 @@ source "$SCRIPTPATH/common.sh"
 
 log_exec_params "$@"
 
-#Script purpose is to build all (or selected) targets in the Hived project.
+#This cript builds all (or selected) targets in the hive repo
 
 print_help () {
     echo "Usage: $0 [OPTION[=VALUE]]... [target]..."
     echo
     echo "Allows to build Hive sources "
     echo "  --source-dir=DIRECTORY_PATH"
-    echo "                       Allows to specify a directory containing a Hived source tree."
+    echo "                       Specify a directory containing a Hived source tree."
     echo "  --binary-dir=DIRECTORY_PATH"
-    echo "                       Allows to specify a directory to store a build output (Hived binaries)."
-    echo "                       Usually it is a \`build\` subdirectory in the Hived source tree."
-    echo "  --cmake-arg=ARG      Allows to specify additional arguments to the CMake tool spawn"
-    echo "  --help               Display this help screen and exit"
+    echo "                       Specify a directory to store a build output (hived binaries)."
+    echo "                       Usually it is a \`build\` subdirectory in the hive source tree."
+    echo "  --cmake-arg=ARG      Specify additional arguments to the CMake tool spawn."
+    echo "  --help               Display this help screen and exit."
     echo
 }
 
@@ -55,7 +55,7 @@ while [ $# -gt 0 ]; do
         exit 0
         ;;
     -*)
-        echo "ERROR: '$1' is not a valid option"
+        echo "ERROR: '$1' is not a valid option."
         echo
         print_help
         exit 1

scripts/build_wasm_beekeeper.sh

@@ -3,15 +3,15 @@
 set -xeuo pipefail
 
 if [ $# -eq 0 ]; then
-  echo "Performing a docker run"
+  echo "Performing a docker run..."
 docker run \
   -it --rm \
   -v $(pwd)/../:/src \
   -u $(id -u):$(id -g) \
   registry.gitlab.syncad.com/hive/common-ci-configuration/emsdk:3.1.43 \
   /bin/bash /src/scripts/build_wasm_beekeeper.sh 1
 else
-  echo "Performing a build"
+  echo "Performing a build..."
   cd /src
   mkdir -vp build_wasm
   rm -rf ./build_wasm/*

scripts/exchange_instance.conf

@@ -10,7 +10,7 @@
 --plugin=wallet_bridge_api
 # Defines a range of accounts to track as a json pair ["from","to"]
 # Uncomment lines to track only your own exchange account
-# tracking more accounts will have a significant impact on resources needed
+# tracking more accounts can have a significant impact on resources needed
 --account-history-rocksdb-track-account-range=[\"binance-hot\",\"binance-hot\"]
 --account-history-rocksdb-track-account-range=[\"bittrex\",\"bittrex\"]
 --account-history-rocksdb-track-account-range=[\"blocktrades\",\"blocktrades\"]

scripts/run_tests.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
-# this script will run tavern test versus hivemind instance at address and port
-# specified in command line args.
+# This script will run tavern test versus a hivemind instance at the address and port
+# specified in the command line args.
 
 # basic call is: ./scripts/run_tests.sh address port
 # example: ./scripts/run_tests.sh localhost 8091

scripts/setup_ubuntu.sh

@@ -2,23 +2,23 @@
 
 set -euo pipefail
 
-# Script purpose is an installation of all packages required to build and run Hived instance.
-# After changing it, please also update and push to the registry a docker image defined in https://gitlab.syncad.com/hive/hive/-/blob/develop/Dockerfile
+# This script installs all packages required to build and run a hived instance.
+# After changing it, be sure to update and push to the registry a docker image defined in https://gitlab.syncad.com/hive/hive/-/blob/develop/Dockerfile
 
-#Updated docker image must be also explicitly referenced in the https://gitlab.syncad.com/hive/hive/-/blob/develop/.gitlab-ci.yml#L11
+# The updated docker image must be also explicitly referenced in the https://gitlab.syncad.com/hive/hive/-/blob/develop/.gitlab-ci.yml#L11
 
 
 print_help () {
     echo "Usage: $0 [OPTION[=VALUE]]..."
     echo
-    echo "Allows to setup this machine for Hived installation"
+    echo "Setup this machine for hived installation"
     echo "OPTIONS:"
-    echo "  --hived-admin-account=NAME  Allows to specify the account name with sudo privileges."
-    echo "  --hived-account=NAME        Allows to specify the account name to be used for hived process."
-    echo "  --runtime                   Allows to install all packages required to run already built hived binary."
-    echo "  --dev                       Allows to install all packages required to build and test hived project (additionally to package set specific to runtime)."
-    echo "  --user                      Allows to install all packages being stored in the user's home directory)."
-    echo "  --help                      Display this help screen and exit"
+    echo "  --hived-admin-account=NAME  Specify the account name with sudo privileges."
+    echo "  --hived-account=NAME        Specify the account name to be used for hived process."
+    echo "  --runtime                   Installs all packages required to run a pre-built hived binary."
+    echo "  --dev                       Installs all packages required to build and test hived project (in addition to the required runtime packages)."
+    echo "  --user                      Installs all packages to the user's home directory)."
+    echo "  --help                      Display this help screen and exit."
     echo
 }