Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

[PATCH 3/3] internal: Document forklevel, locallevel, and exit_pending.



---
 Src/builtin.c | 6 +++++-
 Src/exec.c    | 4 ++++
 Src/params.c  | 6 +++++-
 3 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/Src/builtin.c b/Src/builtin.c
index 5fe5ea6d1..0ecabf854 100644
--- a/Src/builtin.c
+++ b/Src/builtin.c
@@ -5601,7 +5601,11 @@ bin_getopts(UNUSED(char *name), char **argv, UNUSED(Options ops), UNUSED(int fun
     return 0;
 }
 
-/* Flag that we should exit the shell as soon as all functions return. */
+/* Boolean flag that we should exit the shell as soon as all functions return.
+ *
+ * Set by the 'exit' builtin.
+ */
+
 /**/
 mod_export int
 exit_pending;
diff --git a/Src/exec.c b/Src/exec.c
index 0d9d7de7c..50027654a 100644
--- a/Src/exec.c
+++ b/Src/exec.c
@@ -971,6 +971,10 @@ hashcmd(char *arg0, char **pp)
     return cn;
 }
 
+/* The value that 'locallevel' had when we forked. When we get back to this
+ * level, the current process (which is a subshell) will terminate.
+ */
+
 /**/
 int
 forklevel;
diff --git a/Src/params.c b/Src/params.c
index da7a6b4c5..5eaafe34e 100644
--- a/Src/params.c
+++ b/Src/params.c
@@ -44,7 +44,11 @@
 #endif
 #endif
 
-/* what level of localness we are at */
+/* What level of localness we are at.
+ *
+ * Hand-wavingly, this is incremented at every function call and decremented
+ * at every function return.  See startparamscope().
+ */
  
 /**/
 mod_export int locallevel;



Messages sorted by: Reverse Date, Date, Thread, Author