From 573884ef67b10ddcf6595ba32df4b05d4c899407 Mon Sep 17 00:00:00 2001
From: Tom Scavo <trscavo@internet2.edu>
Date: Sat, 6 May 2017 16:29:18 -0400
Subject: [PATCH] Enhance inline documentation

---
 bin/list_all_entities_exported.sh | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

diff --git a/bin/list_all_entities_exported.sh b/bin/list_all_entities_exported.sh
index 9b67bf1..f9a7e78 100755
--- a/bin/list_all_entities_exported.sh
+++ b/bin/list_all_entities_exported.sh
@@ -22,8 +22,16 @@
 
 display_help () {
 /bin/cat <<- HELP_MSG
-	This script produces two CSV files from the InCommon export 
-	aggregate. It is intended to be run as a cron job.
+	This script produces the following files from the InCommon 
+	export aggregate:
+	
+	  $csv_filename1
+	  $csv_filename2
+	
+	The script is intended to be run as a cron job. It can (and
+	should) be run often, to pick up the latest changes to metadata.
+	There is little penalty in doing so since the script uses HTTP
+	Conditional GET to retrieve metadata.
 	
 	Usage: ${0##*/} [-hv] -d OUT_DIR
 	
@@ -59,7 +67,7 @@ HELP_MSG
 }
 
 #######################################################################
-# Bootstrap environment
+# Bootstrap
 #######################################################################
 
 script_name=${0##*/}  # equivalent to basename $0
@@ -99,6 +107,10 @@ if [ -z "$LOG_LEVEL" ]; then
 	LOG_LEVEL=3
 fi
 
+# output filenames
+csv_filename1="all-idps-exported.csv"
+csv_filename2="all-sps-exported.csv"
+
 #######################################################################
 # Process command-line options and arguments
 #######################################################################
@@ -194,8 +206,8 @@ fi
 xml_file="${tmp_dir}/saml-metadata.xml"
 
 # output files
-csv_file1="${tmp_dir}/all-exported-idps.csv"
-csv_file2="${tmp_dir}/all-exported-sps.csv"
+csv_file1="${tmp_dir}/$csv_filename1"
+csv_file2="${tmp_dir}/$csv_filename2"
 
 #######################################################################
 # Main processing