[Reproducible-commits] [dpkg] 52/90: libdpkg: Document functions with Doxygen markup

[Jérémy Bobbio]

This is an automated email from the git hooks/post-receive script.

lunar pushed a commit to branch pu/reproducible_builds
in repository dpkg.

commit 4970a0bfb40325d651b20f418a11ef82964a1d87
Author: Guillem Jover <guillem at debian.org>
Date:   Mon Jun 22 13:19:45 2015 +0200

    libdpkg: Document functions with Doxygen markup
---
 lib/dpkg/path-remove.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/lib/dpkg/path-remove.c b/lib/dpkg/path-remove.c
index 36375b2..0554975 100644
--- a/lib/dpkg/path-remove.c
+++ b/lib/dpkg/path-remove.c
@@ -50,7 +50,9 @@ secure_unlink_statted(const char *pathname, const struct stat *stab)
 	return 0;
 }
 
-/*
+/**
+ * Securely unlink a pathname.
+ *
  * If the pathname to remove is:
  *
  * 1. a sticky or set-id file, or
@@ -107,6 +109,11 @@ secure_remove(const char *pathname)
 	return rc;
 }
 
+/**
+ * Remove a pathname and anything below it.
+ *
+ * This function removes pathname and all its contents recursively.
+ */
 void
 path_remove_tree(const char *pathname)
 {

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/dpkg.git