From 31d10871030b1fa85d33772aa9647d24eb326f05 Mon Sep 17 00:00:00 2001
From: Michael Vines <mvines@gmail.com>
Date: Mon, 27 Aug 2018 09:13:53 -0700
Subject: [PATCH] Documentation

---
 multinode-demo/client.sh                  | 2 ++
 multinode-demo/common.sh                  | 6 +++++-
 multinode-demo/drone.sh                   | 2 ++
 multinode-demo/leader.sh                  | 3 +++
 multinode-demo/metrics_write_datapoint.sh | 3 +++
 multinode-demo/setup.sh                   | 3 +++
 multinode-demo/validator-x.sh             | 4 ++++
 multinode-demo/validator.sh               | 3 +++
 multinode-demo/wallet.sh                  | 2 ++
 9 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/multinode-demo/client.sh b/multinode-demo/client.sh
index 53bdd1c6e..eaa41f976 100755
--- a/multinode-demo/client.sh
+++ b/multinode-demo/client.sh
@@ -2,6 +2,8 @@
 #
 USAGE=" usage: $0 [leader_url] [num_nodes] [--loop] [extra args]
 
+ Run bench-tps against the specified network
+
  leader_url       URL to the leader (defaults to ..)
  num_nodes        Minimum number of nodes to look for while converging
  --loop           Add this flag to cause the program to loop infinitely
diff --git a/multinode-demo/common.sh b/multinode-demo/common.sh
index 4ec72686f..ceedf529e 100644
--- a/multinode-demo/common.sh
+++ b/multinode-demo/common.sh
@@ -1,7 +1,11 @@
 # |source| this file
 #
-# Disable complaints about unused variables in this file:
+# Common utilities shared by other scripts in this directory
+#
+# The following directive disable complaints about unused variables in this
+# file:
 # shellcheck disable=2034
+#
 
 rsync=rsync
 leader_logger="cat"
diff --git a/multinode-demo/drone.sh b/multinode-demo/drone.sh
index ca0744794..3895c71e0 100755
--- a/multinode-demo/drone.sh
+++ b/multinode-demo/drone.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 #
+# Starts an instance of solana-drone
+#
 # usage: $0 <rsync network path to solana repo on leader machine>
 #
 
diff --git a/multinode-demo/leader.sh b/multinode-demo/leader.sh
index 692318d8e..d5b9a9f40 100755
--- a/multinode-demo/leader.sh
+++ b/multinode-demo/leader.sh
@@ -1,4 +1,7 @@
 #!/bin/bash
+#
+# Starts a leader node
+#
 
 here=$(dirname "$0")
 # shellcheck source=multinode-demo/common.sh
diff --git a/multinode-demo/metrics_write_datapoint.sh b/multinode-demo/metrics_write_datapoint.sh
index 00bdb4beb..4e998918a 100755
--- a/multinode-demo/metrics_write_datapoint.sh
+++ b/multinode-demo/metrics_write_datapoint.sh
@@ -1,4 +1,7 @@
 #!/bin/bash -e
+#
+# Send a metrics datapoint
+#
 
 point=$1
 if [[ -z $point ]]; then
diff --git a/multinode-demo/setup.sh b/multinode-demo/setup.sh
index 78771c53a..dbba418fe 100755
--- a/multinode-demo/setup.sh
+++ b/multinode-demo/setup.sh
@@ -1,4 +1,7 @@
 #!/bin/bash
+#
+# Creates a fullnode configuration
+#
 
 here=$(dirname "$0")
 # shellcheck source=multinode-demo/common.sh
diff --git a/multinode-demo/validator-x.sh b/multinode-demo/validator-x.sh
index a0b760812..0c5221089 100755
--- a/multinode-demo/validator-x.sh
+++ b/multinode-demo/validator-x.sh
@@ -1,4 +1,8 @@
 #!/bin/bash
+#
+# Start a dynamically-configured validator node
+#
+
 here=$(dirname "$0")
 
 exec "$here"/validator.sh -x "$@"
diff --git a/multinode-demo/validator.sh b/multinode-demo/validator.sh
index 83d1ed827..88cee3012 100755
--- a/multinode-demo/validator.sh
+++ b/multinode-demo/validator.sh
@@ -1,4 +1,7 @@
 #!/bin/bash
+#
+# Start a validator node
+#
 here=$(dirname "$0")
 # shellcheck source=multinode-demo/common.sh
 source "$here"/common.sh
diff --git a/multinode-demo/wallet.sh b/multinode-demo/wallet.sh
index 70d5b7b16..69a8bcec0 100755
--- a/multinode-demo/wallet.sh
+++ b/multinode-demo/wallet.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 #
+# Runs solana-wallet against the specified network
+#
 # usage: $0 <rsync network path to solana repo on leader machine>"
 #