From d0e2d241c6e3b2e51bc0b49f392cba694ba8976b Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Tue, 23 Apr 2019 15:29:25 +0200
Subject: [PATCH] Add script docstrings
---
Scripts/Install-NewestPackage.ps1 | 4 ++++
Scripts/Install-Service.ps1 | 6 +++++-
Scripts/Make-Package.ps1 | 4 ++--
Scripts/Prepare-Build.ps1 | 2 ++
Scripts/Provide-UpdaterPackage.ps1 | 10 ++++++++++
5 files changed, 23 insertions(+), 3 deletions(-)
diff --git a/Scripts/Install-NewestPackage.ps1 b/Scripts/Install-NewestPackage.ps1
index 8e49263..2dc864c 100644
--- a/Scripts/Install-NewestPackage.ps1
+++ b/Scripts/Install-NewestPackage.ps1
@@ -1,3 +1,7 @@
+# Helper script to locate the latest AutoTx installation package (expected to be
+# in a subdirectory of this script with a name like `build_2019-04-23_12-34-56`)
+# and call the installer script from *within* that package.
+
# Make sure to run from the directory containing the script itself:
$BaseDir = $(Split-Path $MyInvocation.MyCommand.Path)
Push-Location $BaseDir
diff --git a/Scripts/Install-Service.ps1 b/Scripts/Install-Service.ps1
index 5664f87..26bf47b 100644
--- a/Scripts/Install-Service.ps1
+++ b/Scripts/Install-Service.ps1
@@ -1,4 +1,8 @@
-# helper script to install the AutoTx service on a computer
+# Helper script to install the AutoTx service on a computer. It is intended to
+# be run from *within* an AutoTx installation package created with the
+# `Make-Package.ps1` script.
+#
+# NOTE: the script will NOT update an existing installation of AutoTx!
# set our requirements:
#Requires -version 5.1
diff --git a/Scripts/Make-Package.ps1 b/Scripts/Make-Package.ps1
index c74dd40..0843492 100644
--- a/Scripts/Make-Package.ps1
+++ b/Scripts/Make-Package.ps1
@@ -1,5 +1,5 @@
-# helper script to create a package from an AutoTx build that can be used from
-# the included "Install-Service.ps1" script as well as with the AutoTx-Updater
+# Helper script to create a package from an AutoTx build that can be used from
+# the included `Install-Service.ps1` script as well as with the AutoTx-Updater.
# set our requirements:
#Requires -version 5.1
diff --git a/Scripts/Prepare-Build.ps1 b/Scripts/Prepare-Build.ps1
index 05ce5a1..a360ab8 100644
--- a/Scripts/Prepare-Build.ps1
+++ b/Scripts/Prepare-Build.ps1
@@ -1,3 +1,5 @@
+# Helper script to be called by Visual Studio as a "pre-build" command.
+
[CmdletBinding(DefaultParameterSetName="build")]
Param(
[Parameter(Mandatory=$True, ParameterSetName="build")]
diff --git a/Scripts/Provide-UpdaterPackage.ps1 b/Scripts/Provide-UpdaterPackage.ps1
index dfb7f20..0c33798 100644
--- a/Scripts/Provide-UpdaterPackage.ps1
+++ b/Scripts/Provide-UpdaterPackage.ps1
@@ -1,3 +1,13 @@
+# Helper script to locate the latest AutoTx installation package (expected to be
+# in a subdirectory of this script with a name like `build_2019-04-23_12-34-56`)
+# and copy it to the correct path so it can be picked up the AutoTx-Updater.
+#
+# NOTE: the script will prune a few files (currently hardcoded) from the package
+# copied to the central update location to prevent sensitive information from
+# being accidentially leaked through a publicly accessible location (see the
+# `$Exclude` variable below).
+
+
[CmdletBinding()]
Param(
[Parameter(Mandatory=$True)][String] $UpdaterSettings
--
GitLab