Drop deprecated programs from the list of commands in debhelper(7). Closes: #548382

diff --git a/Makefile b/Makefile
index 6c128e268b0b3fe4cd598c4a3aed104974c01f60..3d47ea9351f91d71bd90933434aec7a3a47b0da3 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -10,12 +10,19 @@ MAKEMANLIST=perl -e ' \
                        $$file=<IN>; \
                        close IN; \
                        if ($$file=~m/=head1 .*?\n\n(.*?) - (.*?)\n\n/s) { \
-                               $$collect.="=item $$1(1)\n\n$$2\n\n"; \
+                               my $$item="=item $$1(1)\n\n$$2\n\n"; \
+                               if ($$2!~/deprecated/) { \
+                                       $$list.=$$item; \
+                               } \
+                               else { \
+                                       $$list_deprecated.=$$item; \
+                               } \
                        } \
                } \
                END { \
                        while (<STDIN>) { \
-                               s/\#LIST\#/$$collect/; \
+                               s/\#LIST\#/$$list/; \
+                               s/\#LIST_DEPRECATED\#/$$list_deprecated/; \
                                print; \
                        }; \
                }'
@@ -30,12 +37,9 @@ POD2MAN=pod2man --utf8 -c Debhelper -r "$(VERSION)"
 # l10n to be built is determined from .po files
 LANGS=$(notdir $(basename $(wildcard man/po4a/po/*.po)))
 
-build: version
+build: version debhelper.7
        find . -maxdepth 1 -type f -perm +100 -name "dh*" \
                -exec $(POD2MAN) {} {}.1 \;
-       cat debhelper.pod | \
-               $(MAKEMANLIST) `find . -maxdepth 1 -type f -perm +100 -name "dh_*" | sort` | \
-               $(POD2MAN) --name="debhelper" --section=7  > debhelper.7
        po4a --previous -L UTF-8 man/po4a/po4a.cfg 
        set -e; \
        for lang in $(LANGS); do \
@@ -55,6 +59,11 @@ version:
        printf "package Debian::Debhelper::Dh_Version;\n\$$version='$(VERSION)';\n1" > \
                Debian/Debhelper/Dh_Version.pm
 
+debhelper.7: debhelper.pod
+       cat debhelper.pod | \
+               $(MAKEMANLIST) `find . -maxdepth 1 -type f -perm +100 -name "dh_*" | sort` | \
+               $(POD2MAN) --name="debhelper" --section=7  > debhelper.7
+
 clean:
        rm -f *.1 *.7 Debian/Debhelper/Dh_Version.pm
        po4a --previous --rm-translations --rm-backups man/po4a/po4a.cfg

diff --git a/debhelper.pod b/debhelper.pod
index 78de41d5479f5099ecf3963ccb5e0ce1548db7dc..98aa422cffd48922d1aa31e7586a43ef5a96927f 100644 (file)
--- a/debhelper.pod
+++ b/debhelper.pod
@@ -28,7 +28,7 @@ package contains a tutorial about making your first package using debhelper.
 
 =head1 DEBHELPER COMMANDS
 
-Here is the complete list of available debhelper commands. See their man
+Here is the list of debhelper commands you can use. See their man
 pages for additional documentation.
 
 =over 4
@@ -37,8 +37,20 @@ pages for additional documentation.
 
 =back
 
+=head2 Deprecated Commands
+
+A few debhelper commands are deprecated and should not be used.
+
+=over 4
+
+#LIST_DEPRECATED#
+
+=back
+
+=head2 Other Commands
+
 If a program's name starts with "dh_", and the program is not on the above
-list, then it is not part of the debhelper package, but it should still
+lists, then it is not part of the debhelper package, but it should still
 work like the other programs described on this page.
 
 =head1 DEBHELPER CONFIG FILES

diff --git a/debian/changelog b/debian/changelog
index 1eca2a1f6235b9de9b8f8ac29d81ed40ee816853..b9debf47853c89c966bdfb429cd786e4ba5a0016 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -14,6 +14,8 @@ debhelper (7.4.4) UNRELEASED; urgency=low
   * Add deprecation warnings for -u to the documentation, since putting
     options after -- is much more sane. (However, -u will not go away any
     time soon.) Closes: #554509
+  * Drop deprecated programs from the list of commands in debhelper(7).
+    Closes: #548382
 
  -- Joey Hess <joeyh@debian.org>  Wed, 28 Oct 2009 18:10:45 -0400
 

diff --git a/dh_installmanpages b/dh_installmanpages
index 2257517b0df0efb151cdb92ee85d2b93a8a8b1d6..4a5f4735e29fcb82ad88d26768f5b63e26a2bdd3 100755 (executable)
--- a/dh_installmanpages
+++ b/dh_installmanpages
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_installmanpages - old-style man page installer
+dh_installmanpages - old-style man page installer (deprecated)
 
 =cut
 

diff --git a/dh_python b/dh_python
index 857504f7163c09879107ea15b6267cee78f5013b..8f8c378850a6308c927106c200221a7b5183da74 100755 (executable)
--- a/dh_python
+++ b/dh_python
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_python - calculates python dependencies and adds postinst and prerm python scripts
+dh_python - calculates python dependencies and adds postinst and prerm python scripts (deprecated)
 
 =cut
 

diff --git a/dh_suidregister b/dh_suidregister
index 3bc9bd98ce858320b21406948b23c48ca0517561..5af99e73261bf67011c01ded19d2b4096ff2896a 100755 (executable)
--- a/dh_suidregister
+++ b/dh_suidregister
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_suidregister - obsolete suid registration program
+dh_suidregister - suid registration program (deprecated)
 
 =head1 SYNOPSIS
 
@@ -12,8 +12,8 @@ Do not run!
 
 This program used to register suid and sgid files with L<suidregister(1)>,
 but with the introduction of L<dpkg-statoverride(8)>, registration of files
-in this way is unnecessary, and even harmful, so this program should not be
-used.
+in this way is unnecessary, and even harmful, so this program is deprecated
+and should not be used.
 
 =head1 CONVERTING TO STATOVERRIDE
 

diff --git a/dh_testversion b/dh_testversion
index 9c1c391d01e9a6b86c11a766bece99fe9b940f99..db411ab0a40ff25470e0d11e9829706d843b0529 100755 (executable)
--- a/dh_testversion
+++ b/dh_testversion
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_testversion - ensure that the correct version of debhelper is installed
+dh_testversion - ensure that the correct version of debhelper is installed (deprecated)
 
 =cut
 

diff --git a/dh_undocumented b/dh_undocumented
index 5596485c11b43f5ccedecf2a829f33b5140684d2..32cfbd8b6fdb248e0a4cde1b3a6625ae0b44b41c 100755 (executable)
--- a/dh_undocumented
+++ b/dh_undocumented
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_undocumented - obsolete undocumented.7 symlink program
+dh_undocumented - undocumented.7 symlink program (deprecated no-op)
 
 =cut
 

diff --git a/doc/TODO b/doc/TODO
index 64e5b66af145e31517de2d233b338431b909443f..50418b8df6923057059a1cefd76b67535b84af58 100644 (file)
--- a/doc/TODO
+++ b/doc/TODO
@@ -22,7 +22,8 @@ Deprecated:
 * dh_suidregister. Once nothing in the archive uses it.
 * dh_installmanpages.
 * dh_testversion. Remove as soon as nothing uses it.
-* dh_movefiles. I won't hold my breath.
+* dh_movefiles. I won't hold my breath. Have not added deprecation
+  docs or message yet.
 * dh_undocumented
 * dh_installinit --init-script (make it warn)
 * dh_python