[debhelper-devel] [debhelper] 01/02: Add manpage of obsolete compat levels

[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 94adb2938d708d7fe2051a17cfcc00a8bf9cee13
Author: Niels Thykier <niels at thykier.net>
Date:   Sat Oct 1 07:22:43 2016 +0000

    Add manpage of obsolete compat levels
    
    Signed-off-by: Niels Thykier <niels at thykier.net>
---
 Makefile                      |  10 +++-
 debhelper-obsolete-compat.pod | 124 ++++++++++++++++++++++++++++++++++++++++++
 debhelper.pod                 |   3 +
 debian/changelog              |   3 +
 4 files changed, 138 insertions(+), 2 deletions(-)

diff --git a/Makefile b/Makefile
index e27779b..e5e51c8 100644
--- a/Makefile
+++ b/Makefile
@@ -49,7 +49,7 @@ else
 LANGS=
 endif
 
-build: version debhelper.7
+build: version debhelper.7 debhelper-obsolete-compat.7
 	find . -maxdepth 1 -type f -perm /100 -name "dh*" \
 		-exec $(POD2MAN) {} {}.1 \;
 ifneq ($(USE_NLS),no)
@@ -66,6 +66,9 @@ ifneq ($(USE_NLS),no)
 				$(MAKEMANLIST) `find $$dir -type f -maxdepth 1 -name "dh_*.pod" | LC_ALL=C sort` | \
 				$(POD2MAN) --name="debhelper" --section=7 > debhelper.$$lang.7; \
 		fi; \
+		if [ -e $$dir/debhelper-obsolete-compat.pod ]; then \
+			$(POD2MAN) --name="debhelper" --section=7 $$dir/debhelper-obsolete-compat.pod > debhelper-obsolete-compat.$$lang.7; \
+		fi; \
 	done
 endif
 
@@ -76,7 +79,10 @@ version:
 debhelper.7: debhelper.pod
 	cat debhelper.pod | \
 		$(MAKEMANLIST) $(COMMANDS) | \
-		$(POD2MAN) --name="debhelper" --section=7  > debhelper.7
+		$(POD2MAN) --name="debhelper" --section=7  > $@
+
+debhelper-obsolete-compat.7: debhelper-obsolete-compat.pod
+	$(POD2MAN) --name="debhelper" --section=7 $^ > $@
 
 clean:
 	rm -f *.1 *.7 Debian/Debhelper/Dh_Version.pm
diff --git a/debhelper-obsolete-compat.pod b/debhelper-obsolete-compat.pod
new file mode 100644
index 0000000..1d9f349
--- /dev/null
+++ b/debhelper-obsolete-compat.pod
@@ -0,0 +1,124 @@
+=head1 NAME
+
+debhelper-obsolete-compat - List of no longer supported compat levels
+
+=head1 SYNOPSIS
+
+This document contains the upgrade guidelines from all compat levels
+which are no longer supported.  Accordingly it is mostly for
+historical purposes and to assist people upgrading from a
+non-supported compat level to a supported level.
+
+For upgrades from supported compat levels, please see L<debhelper(7)>.
+
+=head1 UPGRADE LIST FOR COMPAT LEVELS
+
+The following is the list of now obsolete compat levels and their
+changes.
+
+=over 4
+
+=item v1
+
+This is the original debhelper compatibility level, and so it is the default
+one. In this mode, debhelper will use F<debian/tmp> as the package tree
+directory for the first binary package listed in the control file, while using
+debian/I<package> for all other packages listed in the F<control> file.
+
+This mode is deprecated.
+
+=item v2
+
+In this mode, debhelper will consistently use debian/I<package>
+as the package tree directory for every package that is built.
+
+This mode is deprecated.
+
+=item v3
+
+This mode works like v2, with the following additions:
+
+=over 8
+
+=item -
+
+Debhelper config files support globbing via B<*> and B<?>, when appropriate. To
+turn this off and use those characters raw, just prefix with a backslash.
+
+=item -
+
+B<dh_makeshlibs> makes the F<postinst> and F<postrm> scripts call B<ldconfig>.
+
+=item -
+
+Every file in F<etc/> is automatically flagged as a conffile by B<dh_installdeb>.
+
+=back
+
+=item v4
+
+Changes from v3 are:
+
+=over 8
+
+=item -
+
+B<dh_makeshlibs -V> will not include the Debian part of the version number in
+the generated dependency line in the shlibs file.
+
+=item -
+
+You are encouraged to put the new B<${misc:Depends}> into F<debian/control> to
+supplement the B<${shlibs:Depends}> field.
+
+=item -
+
+B<dh_fixperms> will make all files in F<bin/> directories and in F<etc/init.d>
+executable.
+
+=item -
+
+B<dh_link> will correct existing links to conform with policy.
+
+=back
+
+=item v5
+
+This is the lowest supported compatibility level.
+
+Changes from v4 are:
+
+=over 8
+
+=item -
+
+Comments are ignored in debhelper config files.
+
+=item -
+
+B<dh_strip --dbg-package> now specifies the name of a package to put debugging
+symbols in, not the packages to take the symbols from.
+
+=item -
+
+B<dh_installdocs> skips installing empty files.
+
+=item -
+
+B<dh_install> errors out if wildcards expand to nothing.
+
+=back
+
+=back
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+=head1 AUTHORS
+
+Niels Thykier <niels at thykier.net>
+
+Joey Hess
+
+=cut
diff --git a/debhelper.pod b/debhelper.pod
index bd10b34..391007b 100644
--- a/debhelper.pod
+++ b/debhelper.pod
@@ -302,6 +302,9 @@ These are the available compatibility levels:
 
 This is the lowest supported compatibility level.
 
+If you are upgrading from an earlier compatibility level, please
+review L<debhelper-obsolete-compat(7)>.
+
 =item v6
 
 Changes from v5 are:
diff --git a/debian/changelog b/debian/changelog
index 8ce728b..c70cd24 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -12,6 +12,9 @@ debhelper (10+unreleased) UNRELEASED; urgency=medium
     the initial patch.  (Closes: #836988)
   * dh_md5sums.1: Mention dpkg --verify as a consumer of the
     output file.  Thanks to Guillem Jover for reporting it.
+  * debhelper-obsolete-compat.pod: Add a manpage for the
+    upgrade checklist for all obsolete/removed compat levels.
+    Thanks to Jakub Wilk for the suggestion.
 
  -- Niels Thykier <niels at thykier.net>  Wed, 14 Sep 2016 06:07:02 +0000
 

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