Path: csiph.com!aioe.org!bofh.it!news.nic.it!robomod From: Christopher Hoskin Newsgroups: linux.debian.maint.python Subject: Re: Consistent location for library documentation Date: Sat, 03 Mar 2018 13:00:01 +0100 Message-ID: References: X-Original-To: Scott Kitterman X-Mailbox-Line: From debian-python-request@lists.debian.org Sat Mar 3 11:59:43 2018 Old-Return-Path: X-Amavis-Spam-Status: No, score=-7.799 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_FROM=0.001, LDO_WHITELIST=-5, RCVD_IN_DNSWL_LOW=-0.7] autolearn=ham autolearn_force=no X-Policyd-Weight: using cached result; rate: -7 Dkim-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:in-reply-to:references:from:date:message-id:subject:to :cc:content-transfer-encoding; bh=NfRnTink6h1lXdCF5lxGoUkOH08B9ezLncg7meovKq0=; b=Ui1gYeKnK3PVuvqzRDXmluyMEvgIM4iGa1j0s9KlRweN+FpK17Gq4xIIZmbtDbmSVF cg9d0k46FlsnWszGnaGWhFqLpR3ae8YRNRIFYzq0IM6a3ElJVjm5ce5DjUZyypVSZhYf PN9SiPc69OuXS9E5y8wK97oQ94TY8aahZwDfME9Lxgbfs8eJwvc5DhYO3jTSanFRq6C9 vQ9EtjSfB4Dkv9PviTt8kL5tqAps/vRylpS5c4n6sKFMIWwKSHhR88FneZAKECB+Fsiu 0FNhqcZOFCNGVM3RpFYlnDZRLIjnVDGlp15vpydoHWJIE9UZqPRXtgZEHgVu2A28Zvpj E6BA== X-Google-Dkim-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:in-reply-to:references:from:date :message-id:subject:to:cc:content-transfer-encoding; bh=NfRnTink6h1lXdCF5lxGoUkOH08B9ezLncg7meovKq0=; b=PXrv3gEP37iqSRzNa73dUtuyjE4asTyqLV/9jlUby72ZWkVuOu8IS33EkK2hbTWmlN ab97uk3Gx/pCTO6B/MZEhpLx8gdN9VZuwKUHbhPJjFCTJIoQ+V0JUOhCHZbB+209uPRe +zSehOdW+iXxwKrHPVyAScpsuv0ddRYZN62FAva7NeizBK9xhPrNQaPw1S9/IXTd/6qH w+Inrbqlr1QtpehS5v/Dq1GCA6J+/syl3J/WzIY19jkI7wiMCoHLcmi5BhE31V6vk86P 6/rLqirIDMGTKmUk24lLzNcgjOkoX83Anq0/U5FMXumc+CFpbdprfcmkgMfiBAfRzCjF exAA== X-Gm-Message-State: AElRT7EcAb4NQNbcuQlDVdV5ApMOSAaznI/nQsWmFCYTn0on7SlHgCqA 6V1Gc6uHcybyHSYMHMmaHml5NW1kVXjsSLaKI8A+H1N98s0= X-Google-SMTP-Source: AG47ELubQYSPglKtO+gBtsa9tWJShYC7j+t4YMZRJAfTbYSNBVT5LF2vTGhJtck0LPD6ZrIyqLJCHAao19vQ+nxOuCU= X-Received: by 10.55.104.150 with SMTP id d144mr12924107qkc.71.1520078364956; Sat, 03 Mar 2018 03:59:24 -0800 (PST) MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Mailing-List: archive/latest/15618 List-ID: List-URL: List-Archive: https://lists.debian.org/msgid-search/CAEjvcd9fhjQfPcatzabcsBOA6L=zdd4BOFLArEdXKgrb3oPhsg@mail.gmail.com Approved: robomod@news.nic.it Lines: 142 Organization: linux.* mail to news gateway Sender: robomod@news.nic.it X-Original-Cc: debian-python@lists.debian.org X-Original-Date: Sat, 3 Mar 2018 11:59:24 +0000 X-Original-Message-ID: X-Original-References: <85zic56kxk.fsf@benfinney.id.au> <2326393.XF5hSslKiF@kitterma-e6430> Xref: csiph.com linux.debian.maint.python:10223 Thanks - so the policy is that the preference is that documentation is installed in /usr/share/doc/
, but that /usr/share/doc/
-doc is also allowed. The justification is that the documentation is easier for users to find this way. dh_installdocs attempts to compute the name of main package by chopping the -doc off the end of the doc package name in compute_doc_main_package [1]. So, my question is, have we as a team decided that: a) We want to install documentation to /usr/share/doc/
not /usr/share/doc/
-doc b) the Python 2 package is the main package and the Python 3 package is not= ? It seems to me that when Python2 is dropped, compute_doc_main_package will no longer be able to compute the main package (because the python- packages will no longer exist) and existing python--doc packages which install to /usr/share/doc/ will be in breach of the policy. [1] https://salsa.debian.org/debian/debhelper/blob/master/lib/Debian/Debhel= per/Dh_Lib.pm Christopher On 3 March 2018 at 09:56, Scott Kitterman wrote: > Look at Debian Policy, section 12.3 Additional Documentation. The answer= is > there. > > Scott K > > On Saturday, March 03, 2018 09:25:20 AM Christopher Hoskin wrote: >> Dear Ben, >> >> Did you get an answer to this? >> >> I've just noticed a change in behavior of dh_installdocs between >> debhelper compat 10 and 11. With compat 10, documents listed in >> debian/python--doc.docs (e.g. build/html) would get installed >> to /usr/share/doc/python--doc/ but with compat 11, they get >> installed to /usr/share/doc/python-/. >> >> >From the dh_installdocs man page it appears dh_installdocs has some >> >> logic to auto-detect the main package, which can be overridden with >> the --doc-main-package option. >> >> I'd like to know if dh_installdocs' default is considered correct, or >> if I should be overriding it? >> >> Thanks. >> >> Christopher >> >> On 16 July 2017 at 05:54, Ben Finney wrote: >> > Howdy all, >> > >> > Where is the best location for library documentation of a Debian Pytho= n >> > library package? >> > >> > Debian Policy =C2=A712.3 says: >> > [=E2=80=A6] installing the documentation into the documentation di= rectory of >> > the main package is preferred since it is independent of the >> > packaging method and will be easier for users to find. >> > >> > This is clear enough where a library package =E2=80=98libfoo=E2=80=99 = is the main >> > package. The documentation package =E2=80=98libfoo-doc=E2=80=99 can in= stall the >> > documentation to =E2=80=98/usr/share/doc/libfoo/=E2=80=99. >> > >> > >> > With the split in Python runtime systems, though, there is commonly no= t >> > a single =E2=80=9Cmain package=E2=80=9D. Typically there are two, =E2= =80=98python3-foo=E2=80=99 and >> > =E2=80=98python-foo=E2=80=99. >> > >> > The documentation package =E2=80=98python-foo-doc=E2=80=99 then has no= one obvious place >> > to install the documentation: >> > >> > * Installing to =E2=80=98/usr/share/doc/python-foo-doc/=E2=80=99 is di= scouraged by the >> > >> > above Policy section. I agree that is not necessarily an obvious pla= ce >> > for a user to look for =E2=80=98python3-foo=E2=80=99 documentation. >> > >> > * Installing to =E2=80=98/usr/share/doc/python-foo/=E2=80=99 or >> > >> > =E2=80=98/usr/share/doc/python3-foo/=E2=80=99 is incorrect if the co= rresponding >> > library package is not installed. >> > >> > Compounding this is the fact we are (rightly, IMO) moving toward Pytho= n >> > 3 as the primary runtime, and discouraging new Python 2 packages. Is >> > =E2=80=98python3-foo=E2=80=99 then the =E2=80=9Cmain package=E2=80=9D = by the Policy statement above? >> > >> > A symlink could be used, from =E2=80=98/usr/share/doc/libfoo-doc=E2=80= =99 to >> > =E2=80=98/usr/share/doc/libfoo=E2=80=99. But that still runs into the = problem of *which* >> > package should be assumed. >> > >> > And if the documentation package *only* is installed, where should it >> > install its documentation and symlinks? How should this be done to all= ow >> > the library packages to later be installed without changing the >> > documentation location? >> > >> > >> > I have looked at various documentation and can't see good guidance for= a >> > =E2=80=9Cone obvious way=E2=80=9D to resolve this. >> > >> > There is varying practice among packages, and anyway just because some >> > package does it a particular way doesn't mean I should copy that witho= ut >> > knowing whether it's a good idea. >> > >> > What to do? >> > >> > -- >> > >> > \ =E2=80=9CI put contact lenses in my dog's eyes. They ha= d little | >> > >> > `\ pictures of cats on them. Then I took one out and he ran around= | >> > >> > _o__) in circles.=E2=80=9D =E2=80= =94Steven Wright | >> > Ben Finney >