Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.debian.maint.python > #14779 > unrolled thread

Help to package xdoctest

Back to article view | Back to linux.debian.maint.python

Contents

  Help to package xdoctest Bo YU <tsu.yubo@gmail.com> - 2022-12-26 08:10 +0100
    Re: Help to package xdoctest Bo YU <tsu.yubo@gmail.com> - 2022-12-27 14:10 +0100
    Re: Help to package xdoctest Stefano Rivera <stefanor@debian.org> - 2022-12-27 15:40 +0100

#14779 — Help to package xdoctest

Hi,

I am packaging the xdoctest to meet ubelt's[0] B-D.

Now I think it has a good shape in packaging[1], but I am not sure
about below warning:

```
W: python3-xdoctest: no-manual-page [usr/bin/xdoctest]
P: xdoctest source: very-long-line-length-in-source-file 563 > 512
[dev/outline.md:11]
X: python3-xdoctest: application-in-library-section python [usr/bin/xdoctest]
X: xdoctest source: debian-watch-does-not-check-openpgp-signature [debian/watch]
X: python3-xdoctest: library-package-name-for-application [usr/bin/xdoctest]

```
First, the executable program is placed in the /usr/bin directory, right?
In my understanding, Python modules should be put in
/usr/lib/python3/dist-packages/xdoctest. But it is ok for program
entry in /usr/bin also.

If so, I should add manpage for it.

Please help me to confirm it, TIA.

BR,
Bo

[0]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1026966
[1]: https://salsa.debian.org/python-team/packages/xdoctest/-/tree/debian/main/

[toc] | [next] | [standalone]

#14783

Hi,

On Mon, Dec 26, 2022 at 3:01 PM Bo YU <tsu.yubo@gmail.com> wrote:
>
> Hi,
>
> I am packaging the xdoctest to meet ubelt's[0] B-D.
>
> Now I think it has a good shape in packaging[1], but I am not sure
> about below warning:
>
> ```
> W: python3-xdoctest: no-manual-page [usr/bin/xdoctest]
> P: xdoctest source: very-long-line-length-in-source-file 563 > 512
> [dev/outline.md:11]
> X: python3-xdoctest: application-in-library-section python [usr/bin/xdoctest]
> X: xdoctest source: debian-watch-does-not-check-openpgp-signature [debian/watch]
> X: python3-xdoctest: library-package-name-for-application [usr/bin/xdoctest]
>
> ```
...
>
> If so, I should add manpage for it.

Today I try to add -doc package to meet lintian's check, this should
also basic requirement
for Python packages including docs dir. But again I ran into the
problem with the dependency[0] to use
sphinx to generate html, especially since it needs ubelt, the xdoctest
package itself to meet its dependencies.
So what is the better way to solve the issue?

BR,
Bo

[0]: https://salsa.debian.org/python-team/packages/xdoctest/-/blob/debian/main/docs/requirements.txt
>
> Please help me to confirm it, TIA.
>
> BR,
> Bo
>
> [0]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1026966
> [1]: https://salsa.debian.org/python-team/packages/xdoctest/-/tree/debian/main/

[toc] | [prev] | [next] | [standalone]

#14784

Hi Bo (2022.12.26_07:01:29_+0000)
> W: python3-xdoctest: no-manual-page [usr/bin/xdoctest]

Yeah, applications *should* have manual pages, but it's not required. If
you need more tooling to build the manpage, it can wait until those
tools are available in Debian.

> P: xdoctest source: very-long-line-length-in-source-file 563 > 512 [dev/outline.md:11]
> X: xdoctest source: debian-watch-does-not-check-openpgp-signature [debian/watch]

I'd ignore those.

> X: python3-xdoctest: application-in-library-section python [usr/bin/xdoctest]
> X: python3-xdoctest: library-package-name-for-application [usr/bin/xdoctest]

So, technically, xdoctest could be split into an xdoctest binary package
(the command) and python3-xdoctest (the library). Personally, I don't
bother to do that for niche tools like this. If it was a more
user-oriented package, then it could make more sense to split it.

SR

-- 
Stefano Rivera
  http://tumbleweed.org.za/
  +1 415 683 3272

[toc] | [prev] | [standalone]

Back to top | Article view | linux.debian.maint.python

csiph-web