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

Bug#912059: marked as done (debian-policy: please increase ToC depth (for Lintian's benefit))



Your message dated Sat, 27 Oct 2018 19:21:56 +0000
with message-id <E1gGU9k-000AQ2-4M@fasolo.debian.org>
and subject line Bug#912059: fixed in debian-policy 4.2.1.4
has caused the Debian Bug report #912059,
regarding debian-policy: please increase ToC depth (for Lintian's benefit)
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 this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
912059: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=912059
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message ---
Package: debian-policy
Version: 4.2.1.3
Severity: normal
Tags: patch

I recently noticed some outdated links generated by Lintian, which led
me to look into how they're generated.  Lintian has a script
(private/refresh-manual-refs) to grab references from the tables of
contents of various Debian documents, which it then uses in some of its
tags.  That currently has a hack for the main Policy document, dating
from last year:

    'policy' => [
        '/usr/share/doc/debian-policy/policy.html/index.html',
        'https://www.debian.org/doc/debian-policy/',
        # $index_re would match the Policy's TOC and work otherwise, but
        # the TOC is generated only up to 3 levels deep as of 4.1.1.1, and
        # we want refs to all levels.
        qr{
              <(h[2-5])>\s*
              ([A-Z]|[A-Z]?[\d\.]+?)
              \.?\s+
              ([\w\s[:punct:]]+?)
              <a\s(?:[^>]*?)\bhref="([^"]+)".+?</a>
              </\1>
        }x,
        [['_ignored'], ['section'], ['title'], ['url']]
    ],

But this doesn't actually work at the moment: when I run this script it
loses all the policy entries from the output file.  There is some
support for extracting additional subsection references from other
files, but it would take some effort to get this to work for policy,
because the order of fields in the regex would need to be a bit
different when parsing the primary index versus when parsing individual
ch-* files.

I think it would be much simpler to just increase the Policy ToC's
section depth.  That would seem generally slightly more useful (there
isn't so much noise at the fourth level that it would make the ToC
substantially harder to read), and would relieve Lintian from having to
do this hack.

(See also #912055, a similar problem in doc-base.)

diff --git a/policy/index.rst b/policy/index.rst
index aa3fecd..b38e8c3 100644
--- a/policy/index.rst
+++ b/policy/index.rst
@@ -12,7 +12,7 @@ that each package must satisfy to be included in the distribution.
 This is Debian Policy version |policy_version|, released on |policy_date|.
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 4
    :numbered:
    
    ch-scope
@@ -31,7 +31,7 @@ This is Debian Policy version |policy_version|, released on |policy_date|.
 .. toctree::
    :caption: Appendices
    :name: appendix
-   :maxdepth: 3
+   :maxdepth: 4
    :numbered:
 
    ap-pkg-scope

Thanks,

-- 
Colin Watson                                       [cjwatson@debian.org]

--- End Message ---
--- Begin Message ---
Source: debian-policy
Source-Version: 4.2.1.4

We believe that the bug you reported is fixed in the latest version of
debian-policy, which is due to be installed in the Debian FTP archive.

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 912059@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Sean Whitton <spwhitton@spwhitton.name> (supplier of updated debian-policy 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@ftp-master.debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

Format: 1.8
Date: Sat, 27 Oct 2018 11:30:59 -0700
Source: debian-policy
Binary: debian-policy debian-policy-ja
Architecture: source
Version: 4.2.1.4
Distribution: unstable
Urgency: medium
Maintainer: Debian Policy Editors <debian-policy@lists.debian.org>
Changed-By: Sean Whitton <spwhitton@spwhitton.name>
Description:
 debian-policy - Debian Policy Manual and related documents
 debian-policy-ja - Debian Policy Manual and related documents (Japanese)
Closes: 912059
Changes:
 debian-policy (4.2.1.4) unstable; urgency=medium
 .
   * Increase ToC depth 3->4 (Closes: #912059).
Checksums-Sha1:
 89e263d9da094364e24c5478f7046fc3f0a81c27 2019 debian-policy_4.2.1.4.dsc
 cd8117c7ca8b7bb098e22ae0e61bd8a3c0012b3f 528692 debian-policy_4.2.1.4.tar.xz
Checksums-Sha256:
 7dfccf37e46e4e956568834696c6373f2b8d235ecb76eaa318bd5c3f5b22d5e5 2019 debian-policy_4.2.1.4.dsc
 485b1d88a684f789cf7e44e741427a6c65f33c7bb2f9b7745d2baec49fa7323d 528692 debian-policy_4.2.1.4.tar.xz
Files:
 695b086447dd56c4cfa8b172b70fed68 2019 doc optional debian-policy_4.2.1.4.dsc
 4158adca9c9120fbc17ee03b9dd6bc68 528692 doc optional debian-policy_4.2.1.4.tar.xz

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEm5FwB64DDjbk/CSLaVt65L8GYkAFAlvUrv0ACgkQaVt65L8G
YkCQQw//VbW9agox5wXco+hnG8fMLnII9fK9r5Uzl9wXm2XN2i8XHSrmGJ1ZmW0Q
b8I08Nbo3nBeGxAgeAjRoSaw1olly28FJaOTHZJGICXDdfyGMh3FSd4ppnWafbaG
iN+heOpev4CQhawPYhXyAl5wUY+sWr2uQO0RXL+29OZ2gFzCdJjnBC5nTrNjoDz7
+lIj1VDBILjHcvVVKODOmNYzGYjF5xoGUKpa8Y3nkpa7z/+eWESWE51rhnLrBypt
GOO5jk54Rgeu+FrEWTmR2YgzsTMNIHmY+TekzSc1x+5sLKsGw+Pc1TOk5sPz9qSo
ubPBWJtwYVElHaIaMWGqZXSKRQ8wml/sTECKprYyrgwmm74cLFz5kXpI8yZqZBoD
CBeqx3s1+b31nOHRc8ew+p8pxdhfI5NLJ7vvpB2Q9WnKPyD5qkerrzQv3pbv5xHi
g5E+njJll/a98aaqsKBzBF3VvGsKnu/zrkBb+5/RvuQLzJTVDqieO5vjIWM/bkR/
+aQBrn3pVpjpodcefodxfOpzJGY3/fFzldCUIfkU3AYk8/QsUnjE8Udqh22z4VC2
r80mUhukqeSblC0dfsjA2qI9zEVVCyH6YpqiEDuLtMTMsSFJJEz8QN6xfz8A8GLR
aL18j37Rr9m65fgIAXnq6bxeHrnbKLej6wARAXa8+62/gr57VKM=
=O8Ke
-----END PGP SIGNATURE-----

--- End Message ---

Reply to: