summary refs log tree commit diff
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2016-11-02 04:59:25 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2016-11-03 16:44:14 +0000
commit9d460a9d7f68169d0de4bba77ac8890c2664abcb (patch)
treee5a9847417cba38367d540c48f46bb93a8b41e6b
parent4ad1ad9777d2bb27791043b306b65de62deb5f11 (diff)
downloadzsh-9d460a9d7f68169d0de4bba77ac8890c2664abcb.tar.gz
zsh-9d460a9d7f68169d0de4bba77ac8890c2664abcb.tar.xz
zsh-9d460a9d7f68169d0de4bba77ac8890c2664abcb.zip
39806: internal: Document zle's vichgbuf.
-rw-r--r--ChangeLog2
-rw-r--r--Src/Zle/zle_vi.c9
2 files changed, 11 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 12cf892ed..ed07399a6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2016-11-03  Daniel Shahaf  <d.s@daniel.shahaf.name>
 
+	* 39806: Src/Zle/zle_vi.c: internal: Document zle's vichgbuf.
+
 	* 39805: Src/Zle/comp.h, Src/Zle/compcore.c: internal: Document
 	some compadd internals.
 
diff --git a/Src/Zle/zle_vi.c b/Src/Zle/zle_vi.c
index e1cd758f7..213dc15f8 100644
--- a/Src/Zle/zle_vi.c
+++ b/Src/Zle/zle_vi.c
@@ -47,10 +47,19 @@ int vilinerange;
 
 /* last vi change buffer, for vi change repetition */
 
+/*
+ * vichgbufsz: Allocated size of vichgbuf.
+ * vichgbufptr: Length in use.
+ * vichgflag: true whilst inputting a vi normal mode; causes it to be
+ *   accumulated in vichgbuf, incrementing vichgbufptr.
+ */
+
 /**/
 int vichgbufsz, vichgbufptr, vichgflag;
 
 /*
+ * The bytes that make up the current vi command.  See vichgbuf* above.
+ *
  * Examination of the code suggests vichgbuf is consistently tied
  * to raw byte input, so it is left as a character array rather
  * than turned into wide characters.  In particular, when we replay