summary refs log tree commit diff
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2007-02-18 15:01:29 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2007-02-18 15:01:29 +0000
commit910d446ca71f88719d52fd3bb831f5af6c53da85 (patch)
treef5be0803ced045a79443c87ca9a35327be9b0acc
parent9d43d061e186b91a3b3374ea983a56aa699211a5 (diff)
downloadzsh-910d446ca71f88719d52fd3bb831f5af6c53da85.tar.gz
zsh-910d446ca71f88719d52fd3bb831f5af6c53da85.tar.xz
zsh-910d446ca71f88719d52fd3bb831f5af6c53da85.zip
unposted: document some limitations of utils.c
-rw-r--r--ChangeLog5
-rw-r--r--Src/utils.c10
2 files changed, 15 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index f98c24969..5bff35308 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-02-18  Peter Stephenson  <p.w.stephenson@ntlworld.com>
+
+	* unposted: Src/utils.c: document some limitations of
+	getkeystring().
+
 2007-02-16  Peter Stephenson  <pws@csr.com>
 
 	* 23182: Completion/Base/Utility/_arguments: handle
diff --git a/Src/utils.c b/Src/utils.c
index ea2d17149..e6eb69f01 100644
--- a/Src/utils.c
+++ b/Src/utils.c
@@ -4526,6 +4526,16 @@ ucs4toutf8(char *dest, unsigned int wval)
  * - GETKEY_UPDATE_OFFSET is only allowed if GETKEY_DOLLAR_QUOTE is
  *   also present.
  *
+ * *misc is used for various purposes:
+ * - If GETKEY_BACKSLASH_MINUS is set, it indicates the presence
+ *   of \- in the input.
+ * - If GETKEY_BACKSLASH_C is set, it indicates the presence
+ *   of \c in the input.
+ * - If GETKEY_UPDATE_OFFSET is set, it is set on input to some
+ *   mystical completion offset and is updated to a new offset based
+ *   on the converted characters.  All Hail the Completion System
+ *   [makes the mystic completion system runic sign in the air].
+ *
  * The return value is unmetafied unless GETKEY_DOLLAR_QUOTE is
  * in use.
  */