Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Debian's lintian generates a lot of lintian warnings on manpages #367

Open
michel-slm opened this issue Aug 1, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@michel-slm
Copy link
Contributor

Describe the bug
Debian's dropbox package is automatically linted, and it produces a lot of warnings:

https://udd.debian.org/lintian/?packages=distrobox

To Reproduce

dpkg-source -b .
pbuilder-dist sid build ../distrobox*.dsc
lintian ~/pbuilder/sid_result/distrobox*_all.deb --tag-display-limit 0

Expected behavior
no bad-whatis-entry or groff-message warnings

Logs
Run the commands with --verbose and post the log here as a file upload
Attach also the output of podman logs or docker logs, possibly with --latest flag
distrobox-lintian.txt

Desktop (please complete the following information):

  • Are you using podman or docker? N/A
  • Which version or podman or docker? N/A
  • Which version of distrobox? 1.3.1

Additional context
Add any other context about the problem here.

@michel-slm michel-slm added the bug Something isn't working label Aug 1, 2022
@michel-slm
Copy link
Contributor Author

I see the same in the related Ubuntu packages in the PPA

@michel-slm
Copy link
Contributor Author

related: dotnet/sdk#25709

@michel-slm
Copy link
Contributor Author

after 2a26ab6 - and the automatically generated manpages in e8c0cfc -- I'm still getting the same lintian warnings

Comparing e.g. distrobox-create.1 with genisoimage.1, I suspect the NAME section still looks wrong

distrobox-create.1:

.SH NAME
.IP
.nf
\f[C]
distrobox create
distrobox-create
\f[R]
.fi

genisoimage

.SH NAME
genisoimage \- create ISO9660/Joliet/HFS filesystem with optional Rock Ridge attributes
.\" ----------------------------------------

@michel-slm
Copy link
Contributor Author

better repro, use lexgrog:

distrobox/man/man1 on  docs-add-name-section 
⬢ [debian:testing-backports] ❯ lexgrog -d distrobox-create.1
ruid=1001, euid=1001
rgid=1001, egid=1001
++priv_drop_count = 1

ult_src: File distrobox-create.1 in mantree .
++priv_drop_count = 2
--priv_drop_count = 1
++priv_drop_count = 2
--priv_drop_count = 1
record = 'f[C] distrobox create distrobox-createf[R]'
distrobox-create.1: parse failed

distrobox/man/man1 on  docs-add-name-section 
⬢ [debian:testing-backports] ❯ lexgrog -d distrobox.1 
ruid=1001, euid=1001
rgid=1001, egid=1001
++priv_drop_count = 1

ult_src: File distrobox.1 in mantree .
++priv_drop_count = 2
--priv_drop_count = 1
++priv_drop_count = 2
--priv_drop_count = 1
record = 'f[C] distrobox create distrobox-createf[R]'
distrobox.1: parse failed

@89luca89
Copy link
Owner

89luca89 commented Aug 8, 2022

@michel-slm
thanks a lot for the investigation!
so what do you suggest to make it play nicely with the auto-gen?

@89luca89 89luca89 added the documentation Improvements or additions to documentation label Sep 7, 2022
@89luca89 89luca89 changed the title [Error] Debian's lintian generates a lot of lintian warnings on manpages [Documentation] Debian's lintian generates a lot of lintian warnings on manpages Sep 16, 2022
@89luca89 89luca89 removed the bug Something isn't working label Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants