summary refs log tree commit diff
path: root/Src
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2016-06-03 09:59:11 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2016-06-03 20:39:25 +0000
commit9e7cefcc957e1f1201cf90bdef3e8a9fd2bb492b (patch)
treee2079070ec358f9c0307cb1fac77adb515efce17 /Src
parentdcffad8326878c1a4c539b9b32c6b497f4032e5d (diff)
downloadzsh-9e7cefcc957e1f1201cf90bdef3e8a9fd2bb492b.tar.gz
zsh-9e7cefcc957e1f1201cf90bdef3e8a9fd2bb492b.tar.xz
zsh-9e7cefcc957e1f1201cf90bdef3e8a9fd2bb492b.zip
unposted: internal: Document modify().
Diffstat (limited to 'Src')
-rw-r--r--Src/subst.c13
1 files changed, 13 insertions, 0 deletions
diff --git a/Src/subst.c b/Src/subst.c
index f2d0f6553..4e13ce11d 100644
--- a/Src/subst.c
+++ b/Src/subst.c
@@ -4015,6 +4015,19 @@ arithsubst(char *a, char **bptr, char *rest)
     return t;
 }
 
+/* This function implements colon modifiers.
+ *
+ * STR is an in/out parameter.  On entry it is the string (e.g., path)
+ * to modified.  On return it is the modified path.
+ *
+ * PTR is an in/out parameter.  On entry it contains the string of colon
+ * modifiers.  On return it points past the last recognised modifier.
+ *
+ * Example:
+ *     ENTRY:   *str is "."   *ptr is ":AN"
+ *     RETURN:  *str is "/home/foobar" (equal to $PWD)   *ptr points to the "N"
+ */
+
 /**/
 void
 modify(char **str, char **ptr)