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

Bug#167379: marked as done ([INSTALL-INFO] dpkg: toward better info dir formatting)



Your message dated Sat, 25 Oct 2003 17:02:14 -0400
with message-id <E1ADVY6-0003Rz-00@auric.debian.org>
and subject line Bug#167379: fixed in dpkg 1.10.16
has caused the attached Bug report to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what I am
talking about this indicates a serious mail system misconfiguration
somewhere.  Please contact me immediately.)

Debian bug tracking system administrator
(administrator, Debian Bugs database)

--------------------------------------
Received: (at submit) by bugs.debian.org; 1 Nov 2002 22:01:04 +0000
>From joey@dragon.kitenet.net Fri Nov 01 16:01:03 2002
Return-path: <joey@dragon.kitenet.net>
Received: from as5800-83-78.access.naxs.com (dragon.kitenet.net) [216.98.83.78] 
	by master.debian.org with esmtp (Exim 3.12 1 (Debian))
	id 187jqf-00024U-00; Fri, 01 Nov 2002 16:01:02 -0600
Received: from joey by dragon.kitenet.net with local (Exim 3.36 #1 (Debian))
	id 187hm1-0008Dr-00
	for <submit@bugs.debian.org>; Fri, 01 Nov 2002 14:48:05 -0500
Date: Fri, 1 Nov 2002 14:47:44 -0500
From: Joey Hess <joeyh@debian.org>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: dpkg: toward better info dir formatting
Message-ID: <20021101194744.GA31271@dragon.kitenet.net>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="T4sUOijqQbZv57TR"
Content-Disposition: inline
User-Agent: Mutt/1.4i
X-Reportbug-Version: 2.8
Sender: Joey Hess <joey@dragon.kitenet.net>
Delivered-To: submit@bugs.debian.org
X-Spam-Status: No, hits=-7.0 required=5.0
	tests=PATCH_UNIFIED_DIFF,PGP_SIGNATURE_2,SPAM_PHRASE_00_01,
	      USER_AGENT,USER_AGENT_MUTT
	version=2.41
X-Spam-Level: 


--T4sUOijqQbZv57TR
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

Package: dpkg
Version: 1.10.9
Severity: normal
Tag: patch

Something is causing very long titles in the info pages, and this is
leading to stuff like this in the info dir file:

* Date input formats: (coreutils)Date input formats.
* autoconf: (autoconf)autoconf Invocation.           How to create
                                                     configuration scripts

That shove the descriptions over to a 20 or so character wide column.
The overall result makes it a lot harder to read the descriptions than I
recall it being before:

* Bfd: (bfd).                                        The Binary File
                                                     Descriptor library.
* Binutils: (binutils).                              The GNU binary utiliti=
es.
* ar: (binutils)ar.                                  Create, modify, and
                                                     extract from archives
* gprof: (gprof).                                    Profiling your program=
's
                                                     execution

* XaoS: (xaos).                                      The fast realtime
                                                     interactive fractal
                                                     zoomer
* xzgv: (xzgv).                                      A picture viewer for X,
                                                     with a thumbnail-based
                                                     file selector.
* Festival: (festival).                              The `Festival' Speech
                                                     Synthesis System a
                                                     general text to speech
                                                     system for making your
                                                     computer talk and
                                                     developing new synthes=
is
                                                     techniques.

The main cause of the problem seems to be a few packages (coreutils,
autoconf), that choose to use one info file for a number of topics, and
register all of those topic in the top-level info dir. That means that
they have to use rather long info references, like "(coreutils)Date
input formats". The result is a long line which given the current
way install-info lays out the dir file, shoves every description into a
narrow column, with much word-wrapping.

Since I can see no way for the coreutils package to cut this line down,
really, I began to think about reformatting the info dir instead. I have
a patch that makes the descriptions be laid out in a way reminiscent
of .TP lines on man pages, letting descriptions always start in column=20
40 (not ideal, but I haven't tried to make it adaptively pick the best
column yet). The result looks pretty good most of the time:

* Bfd: (bfd).                           The Binary File Descriptor library.
* Binutils: (binutils).                 The GNU binary utilities.
* ar: (binutils)ar.                     Create, modify, and extract from
                                        archives

Looks reasonable for items with longer descriptions:

* XaoS: (xaos).                         The fast realtime interactive fract=
al
                                        zoomer
* xzgv: (xzgv).                         a picture viewer for X, with a
                                        thumbnail-based file selector.
* Festival: (festival).                 The `Festival' Speech Synthesis Sys=
tem
                                        a general text to speech system for
                                        making your computer talk and
                                        developing new synthesis techniques.

And is still readable, though not pretty, for items with oversize
title + references:

* GNU Utilities: (coreutils).           GNU Utilities.
* Common options: (coreutils)Common options.
                                        Common options.
* File permissions: (coreutils)File permissions.
                                        Access modes.
* Date input formats: (coreutils)Date input formats.

With the patch install-info converts the dir file over to the new layout
without problems. I'm only changing whitespace, so none of the dir parsing
seems to break.

Here's the patch:

--- /usr/sbin/install-info	2002-09-15 14:36:46.000000000 -0400
+++ install-info	2002-11-01 14:24:28.000000000 -0500
@@ -408,12 +408,20 @@
 }
 @work =3D @work[0..$j];
=20
+my $descalign=3D40;
+
 @newwork =3D ();
 foreach ( @work ) {
 	if ( m/^(\* *[^:]+: *\(\w[^\)]*\)[^.]*\.)[ \t]*(.*)/ ||
 		m/^([ \t]+)(.*)/ ) {
-		$_ =3D $1 . ( " " x ( $length - length($1) + 1 ) ) . $2;
-		push @newwork, split( "\n", wrap('', " " x ( $length + 1 ), $_ ) );
+		if (length $1 >=3D $descalign) {
+			push @newwork, $1;
+			$_=3D(" " x $descalign) . $2;
+		}
+		else {
+			$_ =3D $1 . (" " x ($descalign - length $1)) . $2;
+		}
+		push @newwork, split( "\n", wrap('', " " x $descalign, $_ ) );
 	} else {
 		push @newwork, $_;
 	}

The obvious enhancement is to make it calculate $descalign better.
The current value of 40 works pretty well for what we have now, and
it should probably not exceed 40 (or we'd go back to the current situation
of not having enough space for the descriptions). It could easily be less
than 40 for some info dirs though.

--=20
see shy jo

--T4sUOijqQbZv57TR
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQE9wtpg3xwsXJZQhyMRAisNAJ4xLbcFl5sQV/5yO2oOZ4J38RL9GQCeJIYP
h3CqCiaRtMhb6GkjbPCqePo=
=BP7m
-----END PGP SIGNATURE-----

--T4sUOijqQbZv57TR--

---------------------------------------
Received: (at 167379-close) by bugs.debian.org; 25 Oct 2003 21:08:45 +0000
>From katie@auric.debian.org Sat Oct 25 16:08:45 2003
Return-path: <katie@auric.debian.org>
Received: from auric.debian.org [206.246.226.45] 
	by master.debian.org with esmtp (Exim 3.35 1 (Debian))
	id 1ADVeP-0001hq-00; Sat, 25 Oct 2003 16:08:45 -0500
Received: from katie by auric.debian.org with local (Exim 3.35 1 (Debian))
	id 1ADVY6-0003Rz-00; Sat, 25 Oct 2003 17:02:14 -0400
From: Adam Heath <doogie@debian.org>
To: 167379-close@bugs.debian.org
X-Katie: $Revision: 1.42 $
Subject: Bug#167379: fixed in dpkg 1.10.16
Message-Id: <E1ADVY6-0003Rz-00@auric.debian.org>
Sender: Archive Administrator <katie@auric.debian.org>
Date: Sat, 25 Oct 2003 17:02:14 -0400
Delivered-To: 167379-close@bugs.debian.org

Source: dpkg
Source-Version: 1.10.16

We believe that the bug you reported is fixed in the latest version of
dpkg, which is due to be installed in the Debian FTP archive:

dpkg-dev_1.10.16_all.deb
  to pool/main/d/dpkg/dpkg-dev_1.10.16_all.deb
dpkg-doc_1.10.16_all.deb
  to pool/main/d/dpkg/dpkg-doc_1.10.16_all.deb
dpkg_1.10.16.dsc
  to pool/main/d/dpkg/dpkg_1.10.16.dsc
dpkg_1.10.16.tar.gz
  to pool/main/d/dpkg/dpkg_1.10.16.tar.gz
dpkg_1.10.16_i386.deb
  to pool/main/d/dpkg/dpkg_1.10.16_i386.deb
dselect_1.10.16_i386.deb
  to pool/main/d/dpkg/dselect_1.10.16_i386.deb



A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 167379@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Adam Heath <doogie@debian.org> (supplier of updated dpkg package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Format: 1.7
Date: Sat, 25 Oct 2003 15:46:16 -0500
Source: dpkg
Binary: dpkg-doc dpkg dselect dpkg-dev dpkg-static
Architecture: source all i386
Version: 1.10.16
Distribution: unstable
Urgency: low
Maintainer: Dpkg Development <debian-dpkg@lists.debian.org>
Changed-By: Adam Heath <doogie@debian.org>
Description: 
 dpkg       - Package maintenance system for Debian
 dpkg-dev   - Package building tools for Debian
 dpkg-doc   - Dpkg Internals Documentation
 dselect    - a user tool to manage Debian packages
Closes: 111711 112057 117518 138244 142370 149142 151800 151802 155219 157819 162154 162691 164906 167379 171489 192972 209355 211816 212796
Changes: 
 dpkg (1.10.16) unstable; urgency=low
 .
   * Almost *EVERY* damn file was including config.h in the wrong spot.
     After making it the first include, then off_t/size_t/etc could actually
     be redefined to be 64-bit compatible.
   * Jordi Mallach <jordi@debian.org>:
     Fix configure to set HAVE_SETLOCALE.  Closes: #211816
   * "Loïc Le Loarer" <lll_deb@m4x.org>:
     Add a -d|--chdir option to start-stop-daemon.  Closes: #151802
   * Split the background block into 2 parts: one that does the fork, and
     opens /dev/tty and /dev/null, and one that does everything else.  The
     second block is then moved to be run right before the exec.  This
     allows error messages to be seen from the child(previously, they were
     lost), and allows for the chroot to not require the device files.
     These changes based on the bugs filed by:
     Marc Herbert <Marc.Herbert@ens-lyon.fr>: Closes: #155219
     Loïc Le Loarer <lll_deb@m4x.org>: Closes: #151800
   * Mario Lang <mlang@debian.org>:
     When --start, --startas and --pidfile are given, print 'process'
     instead of '(null)' for the process name, if it's already running.
     Closes: #209355
   * Imported several translated manpages, from debian-doc cvs:
     * Spanish: 822-date.1 cleanup-info.8 deb-control.5 deb-old.5
       deb.5 dpkg-checkbuilddeps.1 dpkg-deb.1 dpkg-divert.8 dpkg-name.1
       dpkg-scanpackages.8 dpkg-split.8 dpkg-statoverride.8 dpkg.8
       dselect.8 md5sum.1 start-stop-daemon.8 update-alternatives.8
       "Esteban Manchado Velázquez" <zoso@debian.org>: Closes: #171489
     * French: deb.5
       Julien Louis <arthur51@ifrance.com>: Closes: #164906
     * Portuguese: dpkg.8 dselect.8
   * Matt Zimmerman <mdz@debian.org>
     In dpkg's manpage, -O had an inverted word.  Closes: #111711
   * Marcin Owsiany <porridge@debian.org>:
     Fix Polish translation of 'conflicts with'  Closes: #112057
   * Jiri Masik <masik@darbujan.fzu.cz>:
     Improve Czech translation of: "dpkg - warning: ignoring request to
     remove %s which isn't installed."  Closes: #117518
   * Marco Nenciarini <mnencia@prato.linux.it>:
     Fix missing space in Italian translation when listing files, and the
     file is diverted.  Closes: #138244
   * Piotr Roszatycki <Piotr_Roszatycki@netia.net.pl>:
     Update Polish translation.  Closes: #142370
   * Martin Quinson <mquinson@ens-lyon.fr>:
     Fix missing space in French translation of: "%s - warning: downgrading
     %.250s from %.250s to %.250s.\n"  Closes: #149142
   * Hidetaka Iwai <tyuyu@sings.jp>:
     Fix typo in Japanese translation of dpkg --force-help; dowgrade ->
     downgrade:  Closes: #157819
   * Martin Quinson <mquinson@ens-lyon.fr>:
     Fix French translation when listing files, and the file is diverted.
     Closes: #162154
   * Rune Schjellerup <olberd@odense.kollegienet.dk>:
     Fix Danish translation of(was missing the leading space): " does not
     appear to be available\n"  Closes: #192972
   * Fix md5sum when handling large files.  Closes: #162691
   * Fix dpkg-checkbuilddeps calling of parsedep.  It wasn't setting
     use_arch.  Closes: #212796.
   * Joey Hess <joeyh@debian.org>:
     Change formatting of info.dir.  Closes: #167379.
Files: 
 f25c4f9b73002753e8efdc33a57d7ad5 756 base required dpkg_1.10.16.dsc
 240bb2a8ad67ff8fe536d49b1bc17127 1601179 base required dpkg_1.10.16.tar.gz
 1fad4d36d2ab50e32800eaaeba1f3bac 1136408 base required dpkg_1.10.16_i386.deb
 e6982ddda530904a1f9008bdb9bce0f2 95046 base required dselect_1.10.16_i386.deb
 12b7a1bef1573359f170210efef6224c 114224 utils standard dpkg-dev_1.10.16_all.deb
 b35417beff28f92dd7e7971e5139195a 10640 doc optional dpkg-doc_1.10.16_all.deb

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (GNU/Linux)

iD8DBQE/muKFiix9wovUpIkRAjPxAJ9tYar55J3vW1BhiP/IbGCGgsfUAACdFijn
wMmrspkeCYHSEchxsHRRa+8=
=t1o8
-----END PGP SIGNATURE-----



Reply to: