db/update/Walk: document FindAncestorLoop()

2014-02-09 10:45:38 +01:00 · 2014-02-09 10:45:38 +01:00 · e29a8b3a9c
commit e29a8b3a9c
parent ace3f37af4
1 changed files with 6 additions and 0 deletions
--- a/src/db/update/Walk.cxx
+++ b/src/db/update/Walk.cxx
@ -152,6 +152,12 @@ update_directory_stat(Storage &storage, Directory &directory)
 }
 #endif

+/**
+ * Check the ancestors of the given #Directory and see if there's one
+ * with the same device/inode number, building a loop.
+ *
+ * @return 1 if a loop was found, 0 if not, -1 on I/O error
+ */
 static int
 FindAncestorLoop(Storage &storage, Directory *parent,
 		 unsigned inode, unsigned device)