From 5003d5eeffbd2b8d9645db07b6e081d91817c4c1 Mon Sep 17 00:00:00 2001
From: "R. Tyler Croy" <rtyler@brokenco.de>
Date: Fri, 1 Jan 2021 10:08:17 -0800
Subject: [PATCH] Add some comments to all the existing defined ztasks

---
 tasks/echo.ztask            | 5 +++++
 tasks/install/freebsd.ztask | 4 ++++
 tasks/install/zypper.ztask  | 4 ++++
 tasks/shell/bash.ztask      | 7 +++++++
 tasks/shell/sh.ztask        | 4 ++++
 5 files changed, 24 insertions(+)

diff --git a/tasks/echo.ztask b/tasks/echo.ztask
index 5c892e5..8fe19fd 100644
--- a/tasks/echo.ztask
+++ b/tasks/echo.ztask
@@ -1,3 +1,8 @@
+/*
+ * The echo test takes a string and just uses the shell `echo` on the target
+ * to echo it back
+ */
+
 task Echo {
     parameters {
         msg {
diff --git a/tasks/install/freebsd.ztask b/tasks/install/freebsd.ztask
index b1c3712..de47f33 100644
--- a/tasks/install/freebsd.ztask
+++ b/tasks/install/freebsd.ztask
@@ -1,3 +1,7 @@
+/*
+ * Invoke pkg-install(8) on the FreeBSD machine
+ */
+
 task FreeBSDPkgInstall {
     parameters {
         packages {
diff --git a/tasks/install/zypper.ztask b/tasks/install/zypper.ztask
index 736010e..ce2016b 100644
--- a/tasks/install/zypper.ztask
+++ b/tasks/install/zypper.ztask
@@ -1,3 +1,7 @@
+/*
+ * Invoke zypper install on a openSUSE/SLES target
+ */
+
 task ZypperInstall {
     parameters {
         packages {
diff --git a/tasks/shell/bash.ztask b/tasks/shell/bash.ztask
index 44c2e3f..5626524 100644
--- a/tasks/shell/bash.ztask
+++ b/tasks/shell/bash.ztask
@@ -1,3 +1,10 @@
+/*
+ * The bash task is a simple passthrough to bash.
+ *
+ * Since bash is not guaranteed to be in the same location on every machine
+ * This relies on /usr/bin/env to help find bash in the $PATH on the target
+ */
+
 task Bash {
     parameters {
         script {
diff --git a/tasks/shell/sh.ztask b/tasks/shell/sh.ztask
index 6ccbe6c..6aa3acf 100644
--- a/tasks/shell/sh.ztask
+++ b/tasks/shell/sh.ztask
@@ -1,3 +1,7 @@
+/*
+ * The sh task is a simple passthrough to /bin/sh on the target machine
+ */
+
 task Sh {
     parameters {
         script {