db/update/Walk: document FindAncestorLoop()

e29a8b3a · Max Kellermann · ace3f37a · e29a8b3a
Commit e29a8b3a authored Feb 09, 2014 by Max Kellermann
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

Walk.cxx src/db/update/Walk.cxx +6 -0

No files found.
--- 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)