pkg: document pkg_traverse()

2011-07-26 20:15:44 -05:00 · 2011-07-26 20:15:44 -05:00 · 8543f1bdd4
parent 03c9402e98
commit 8543f1bdd4
1 changed files with 5 additions and 0 deletions
--- a/pkg.c
+++ b/pkg.c
@ -232,6 +232,11 @@ pkg_verify_graph(pkg_t *root, int depth)
 	pkg_traverse(root, NULL, NULL, depth);
 }

+/*
+ * pkg_traverse(root, pkg_traverse_func, data, maxdepth)
+ *
+ * walk the dependency graph up to maxdepth levels.  -1 means infinite recursion.
+ */
 void
 pkg_traverse(pkg_t *root,
 	void (*pkg_traverse_func)(pkg_t *package, void *data),