From ed7497e3790b044ab680fcdcd9dc4034a73ead9a Mon Sep 17 00:00:00 2001
From: Daniel Shahaf <d.s@daniel.shahaf.name>
Date: Mon, 11 Sep 2017 15:06:05 +0000
Subject: unposted: internal: Document zreaddir().

---
 ChangeLog   |  4 ++++
 Src/utils.c | 10 ++++++++++
 2 files changed, 14 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 8fa3d1500..05eae682c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2017-09-11  Daniel Shahaf  <d.s@daniel.shahaf.name>
+
+	* unposted: Src/utils.c: internal: Document zreaddir().
+
 2017-09-11  Peter Stephenson  <p.stephenson@samsung.com>
 
 	* Thierry Ghelew: 41666: Src/Modules/zpty.c: zpty compatibility
diff --git a/Src/utils.c b/Src/utils.c
index 5055d69fe..70aad396a 100644
--- a/Src/utils.c
+++ b/Src/utils.c
@@ -4947,6 +4947,16 @@ ztrsub(char const *t, char const *s)
     return l;
 }
 
+/*
+ * Wrapper for readdir().
+ *
+ * If ignoredots is true, skip the "." and ".." entries.
+ *
+ * When __APPLE__ is defined, recode dirent names from UTF-8-MAC to UTF-8.
+ *
+ * Return the dirent's name, metafied.
+ */
+
 /**/
 mod_export char *
 zreaddir(DIR *dir, int ignoredots)
-- 
cgit 1.4.1