about summary refs log tree commit diff
path: root/Etc/zsh-development-guide
diff options
context:
space:
mode:
authorBarton E. Schaefer <schaefer@zsh.org>2015-11-08 12:42:00 -0800
committerBarton E. Schaefer <schaefer@zsh.org>2015-11-08 12:42:00 -0800
commit7277cc1bedaa335b96ce609b4390618358198c32 (patch)
tree21d81684cfe5899394c4198264ace4ade0cca2c8 /Etc/zsh-development-guide
parente8d6041f69f8bfde92ebdd09410bde3ae88978ff (diff)
downloadzsh-7277cc1bedaa335b96ce609b4390618358198c32.tar.gz
zsh-7277cc1bedaa335b96ce609b4390618358198c32.tar.xz
zsh-7277cc1bedaa335b96ce609b4390618358198c32.zip
37079: better description of "optstr" field in struct builtin as used in BUILTIN() macro
Diffstat (limited to 'Etc/zsh-development-guide')
-rw-r--r--Etc/zsh-development-guide4
1 files changed, 3 insertions, 1 deletions
diff --git a/Etc/zsh-development-guide b/Etc/zsh-development-guide
index 9ca441bd8..c4aa1b243 100644
--- a/Etc/zsh-development-guide
+++ b/Etc/zsh-development-guide
@@ -503,7 +503,9 @@ arguments are:
   - the options the builtin accepts, given as a string containing the
     option characters (the above example makes the builtin accept the
     options `f', `l', `a', `g', and `s').  Passing NULL here disables
-    all flag handling, i.e. even "--".
+    all flag handling, i.e. even "--".  Each option letter may be
+    followed by one of ":" (argument must follow), "::" (optional
+    argument may follow), or ":%" (optional numeric argument).
   - and finally a optional string containing option characters that
     will always be reported as set when calling the C-function (this,
     too, can be used when using one C-function to implement multiple