[debhelper-devel] [debhelper] 06/17: doc/PROGRAMMING: Correct log_installed_files

[Niels Thykier]

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

nthykier pushed a commit to branch master
in repository debhelper.

commit 0b6764bc07a58c5513f131e36523e947f6f30785
Author: Niels Thykier <niels at thykier.net>
Date:   Mon Apr 3 09:46:42 2017 +0000

    doc/PROGRAMMING: Correct log_installed_files
    
    After testing, it became apparent that dh_missing +
    log_installed_files behaved slightly different than first anticipated.
    
    Signed-off-by: Niels Thykier <niels at thykier.net>
---
 doc/PROGRAMMING | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index 10cbade..0236280 100644
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -348,10 +348,15 @@ deprecated_functionality($warn_msg[, $rm_compat[, $rm_msg]])
 	The function will provide a separate diagnostic about which compat
 	level that will remove/removed the functionality if $rm_compat is
 	given.
-log_installed_files($package, @patterns)
+log_installed_files($package, @paths)
 	Creates a logfile (in debian/.debhelper/generated) for the helper's
 	processing of $package, which installed the files listed in
-	@patterns. This logfile will later be used by the dh_missing helper.
+	@paths. This logfile will later be used by the dh_missing helper.
+	Paths should be relative to the package root (i.e. the directory
+	containing "debian/") and should not have superflouos segments
+	(e.g. avoid "foo/../bar" or "foo/./bar")
+	If a directory is listed, it and all paths recursively beneath is
+	also considered installed.
 
 Sequence Addons:
 ---------------

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