[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#771315: (pre-approval for) unblock: dictionaries-common/1.23.17



Package: release.debian.org
Severity: normal
User: release.debian.org@packages.debian.org
Usertags: unblock

(pre-approval) Please unblock package dictionaries-common

Hi, release team,

I would like to upload to sid a new dictionaries-common package with some
documentation fixes, to deal with some wrong information (#770484), see
attached patch.

When dealing with dictionaries using autobuildhash at postinst, symlinks to
the actual hashes under /var were previosuly created by
installdeb-{a,i}spell scripts. 

This is no longer the case since some time ago, but that behavior is still
shown as available in installdeb-{a,i}spell man pages (#770484).

I think is important not to have wrong info in the man pages and that is why
I set bugs's severity to Important, but others might think differently. 
I would like to upload a fixed package, but since severity might be
considered different I would like to confirm first if you consider these
changes eligible for a freeze exception.

Although the change was announced a while ago in the dict-common-dev mailing
list, I made more clear what it implies in a reply that was bcc'ed to all
related packages. This means that the practical impact of that wrong info
is not that grave, but I would prefer the info be fixed in jessie if
possible.

Thanks and regards,

-- 
Agustin
From 33c3b7feecd5b09ae10e3fc77475011065a0ca15 Mon Sep 17 00:00:00 2001
From: Agustin Martin Domingo <agmartin@debian.org>
Date: Fri, 21 Nov 2014 17:36:59 +0100
Subject: [PATCH] installdeb.in: Fix info about automatic symlink creation. Add
 info about substvars (Closes: #770484).

installdeb-ispell and installdeb-aspell man pages wrongly state that unless
previous stuff exists,

/usr/lib/{a,i}spell}/$hash -> /var/lib/{a,i}spell/$hash

symlinks will be automatically created.

This is no longer true since 1.23.0, those symlinks are now created by
autobuildhash scripts when needed, and not created by the installdeb-*
script. Maintainers cannot rely on this old feature, and documentation must
clearly show that.

Also, this requires dictionaries-common version for newly built ispell and
aspell dictionary packages to be at least 1.23.0. Otherwise, installation
in wheezy might be attempted and will fail (see #769552) instead of
complaining about an insufficient dependency on dictionaries-common.

Another feature was included in 1.21.0, substvar variables, but info about
it was not included in the relevant pod section, and this is very useful to
keep Depends line up to date.
---
 debian/changelog                | 10 ++++++++++
 scripts/debhelper/installdeb.in | 40 ++++++++++++++++++++++++++++++----------
 2 files changed, 40 insertions(+), 10 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 4c75763..fecae42 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,13 @@
+dictionaries-common (1.23.17) unstable; urgency=medium
+
+  * installdeb.in: Important documentation fix (Closes: #770484).
+    - Fix info about this script automatically creating symlinks for
+      hashes created by {a,i}spell-autobuildhash.  This is not true
+      since 1.23.0.
+    - Add info about specific substvar variables.
+
+ -- Agustin Martin Domingo <agmartin@debian.org>  Fri, 21 Nov 2014 17:36:35 +0100
+
 dictionaries-common (1.23.16) unstable; urgency=medium
 
   * aspell-autobuildhash: Do not return a '0' string on failed autobuild,
diff --git a/scripts/debhelper/installdeb.in b/scripts/debhelper/installdeb.in
index bc15812..1b738d7 100644
--- a/scripts/debhelper/installdeb.in
+++ b/scripts/debhelper/installdeb.in
@@ -160,6 +160,16 @@ F<debian/package.info-[I:ispell:][A:aspell:][H:hunspell:][W:wordlist:]>.  If thi
 successfully parsed, it is installed in the
 F</var/lib/dictionaries-common/[I:ispell:][A:aspell:][H:hunspell:][W:wordlist:]> directory.
 
+=item * Substvars substitutions
+
+This script will populate a F<substvars> file, so Depends line in
+control file can contain
+${[I:ispell:][A:aspell:][H:hunspell:][W:wordlist:]:Depends} to
+automatically care for dictionaries-common dependencies.
+
+This requires C<Build-Depends> on at least dictionaries-common-dev
+1.23.0 and is highly recommended.
+
 =item * Debconf files
 [IW:
 =over
@@ -268,10 +278,13 @@ one to create/reset compatfile(s) in postinst and the other to remove
 files in a removal list from postrm.
 Removal list will contain compat file(s) and associated hash(es) with
 the same basename.
-Unless previous stuff exists,
-F</usr/lib/ispell}/$dict.hash -E<gt> /var/lib/ispell/$dict.hash>
-symlinks will also be automatically created.
-:I][A:
+
+F</usr/lib/ispell/$dict.hash -E<gt> /var/lib/ispell/$dict.hash>
+symlinks are no longer created automatically by this script.
+They are now created by new ispell-autobuildhash together with the
+relevant hashes.
+Make sure to depend on at least dictionaries-common 1.23
+(See F<dictionaries-common.checklist>). :I][A:
 
 =item * Extra installdeb-aspell options in Language info file
 
@@ -285,11 +298,9 @@ files in a removal list (initially containing compat files) from
 postrm.  If C<'auto-contents'> entry is found, contents file at
 F<debian/> will be parsed and its contents added to the removal list,
 otherwise a hash with the same basename of the compatfile is expected
-and added to the removal list.  Unless previous stuff exists,
-F</usr/lib/aspell}/$dict.rws -E<gt> /var/lib/aspell/$dict.rws>
-symlinks will also be automatically created.  If you use a contents
-file and enable it in C<'auto-contents'> you usually will need only
-the same base name enabled in C<'auto-compat'>.
+and added to the removal list.  If you use a contents file and enable
+it in C<'auto-contents'> you usually will need only the same base name
+enabled in C<'auto-compat'>.
 
 If you are interested in a simple install of a pristine aspell
 dictionary with a minimal debian/rules please look at
@@ -297,6 +308,13 @@ L<dh_aspell-simple(1)>.
 You will still need an aspell-info file, but compat/contents stuff
 will be guessed if not explicitly provided in the aspell-info file.
 
+F</usr/lib/aspell/$dict.rws -E<gt> /var/lib/aspell/$dict.rws>
+symlinks are no longer created automatically by this script.
+They are now created by new aspell-autobuildhash together with the
+relevant hashes.
+Make sure to depend on at least dictionaries-common 1.23
+(See F<dictionaries-common.checklist>).
+
 :A]
 
 =back
@@ -335,7 +353,9 @@ building.
 
 =head1 SEE ALSO
 
-debhelper(1)
+debhelper(1),
+dictionaries-common.checklist,
+dsdt-policy.txt
 
 This program is part of the dictionaries-common-dev package. It is
 intended to be used by maintainers of
-- 
2.1.3

Attachment: signature.asc
Description: Digital signature


Reply to: