From 815b33de93064373de88fed78c4a34bb5cec02f9 Mon Sep 17 00:00:00 2001
From: Tom Scavo <trscavo@internet2.edu>
Date: Thu, 6 Apr 2017 14:12:35 -0400
Subject: [PATCH] Document required environment variables

---
 lib/md_tools.sh | 34 ++++++++++++++++++++++++++++++----
 1 file changed, 30 insertions(+), 4 deletions(-)

diff --git a/lib/md_tools.sh b/lib/md_tools.sh
index 61a6d7d..8b76e00 100755
--- a/lib/md_tools.sh
+++ b/lib/md_tools.sh
@@ -277,8 +277,9 @@ construct_mdq_url () {
 #
 #   entityID registrarID
 #
-# where entityID is the value of the ./@entityID XML attribute. The 
-# entityID is guaranteed to be non-null.
+# where entityID is the value of the ./@entityID XML attribute. 
+# Assuming the XML is schema-valid, the entityID is guaranteed to 
+# be non-null.
 #
 # The registrarID is the value of the following XML attribute:
 #
@@ -286,6 +287,14 @@ construct_mdq_url () {
 #
 # Since the mdrpi:RegistrationInfo element is an optional element,
 # the registrarID may be null.
+#
+# Environment Variables
+#
+# Two environment variables are required. The LIB_DIR environment
+# variable points to a source code library containing bash scripts,
+# XSLT scripts, and other source files. The TMPDIR environment 
+# variable points to a temporary directory used by this function.
+#
 #######################################################################
 extractIdentifiers () {
 
@@ -382,8 +391,9 @@ extractIdentifiers () {
 #
 #   entityID DisplayName OrganizationName OrganizationDisplayName registrarID
 #
-# where entityID is the value of the ./@entityID XML attribute. The 
-# entityID is the only field guaranteed to be non-null.
+# where entityID is the value of the ./@entityID XML attribute. 
+# Assuming the XML is schema-valid, the entityID is guaranteed to 
+# be non-null.
 #
 # The DisplayName field is the value of the following XML element:
 #
@@ -407,6 +417,14 @@ extractIdentifiers () {
 #
 # Since the mdrpi:RegistrationInfo element is an optional element,
 # the registrarID may be null.
+#
+# Environment Variables
+#
+# Two environment variables are required. The LIB_DIR environment
+# variable points to a source code library containing bash scripts,
+# XSLT scripts, and other source files. The TMPDIR environment 
+# variable points to a temporary directory used by this function.
+#
 #######################################################################
 extractIdPNames () {
 
@@ -522,6 +540,14 @@ extractIdPNames () {
 # which case the endpoint is a so-called IdP SSO endpoint.
 #
 # A return code > 1 is a fatal error.
+#
+# Environment Variables
+#
+# Two environment variables are required. The LIB_DIR environment
+# variable points to a source code library containing bash scripts,
+# XSLT scripts, and other source files. The TMPDIR environment 
+# variable points to a temporary directory used by this function.
+#
 #######################################################################
 listEndpoints () {