X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/b23c29063064570b1d9f7d8922251455a85927bd..b4235b3165fda2c09072ed830de9a13db5e81b41:/flist.c

diff --git a/flist.c b/flist.c
index ead49665..3d0ff535 100644
--- a/flist.c
+++ b/flist.c
@@ -192,6 +192,13 @@ static void list_file_entry(struct file_struct *f)
 }
 
 
+/**
+ * Stat either a symlink or its referent, depending on the settings of
+ * copy_links, copy_unsafe_links, etc.
+ *
+ * @return -1 on error; or 0.  If a symlink, then @p Linkbuf (of size
+ * MAXPATHLEN) contains the symlink target.
+ **/
 int readlink_stat(const char *Path, STRUCT_STAT * Buffer, char *Linkbuf)
 {
 #if SUPPORT_LINKS