about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog5
-rw-r--r--Src/params.c8
2 files changed, 12 insertions, 1 deletions
diff --git a/ChangeLog b/ChangeLog
index 71bdf9593..625e4a639 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2020-01-23  Daniel Shahaf  <danielsh@apache.org>
+
+	* 45340: Src/params.c: internal: Document the difference between
+	paramtab and realparamtab.
+
 2020-01-19  Eitan Adler  <lists@eitanadler.com>
 
 	* 45332: Completion/Unix/Command/_git: add completion for
diff --git a/Src/params.c b/Src/params.c
index 5eaafe34e..863b32600 100644
--- a/Src/params.c
+++ b/Src/params.c
@@ -478,7 +478,13 @@ static initparam argvparam_pm = IPDEF9("", &pparams, NULL, \
 
 static Param argvparam;
 
-/* hash table containing the parameters */
+/* "parameter table" - hash table containing the parameters
+ *
+ * realparamtab always points to the shell's global table.  paramtab is sometimes
+ * temporarily changed to point at another table, while dealing with the keys
+ * of an associative array (for example, see makecompparams() which initializes
+ * the associative array ${compstate}).
+ */
  
 /**/
 mod_export HashTable paramtab, realparamtab;