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

dbk2man.py generates incorrect man pages #56

Open
Mno-hime opened this issue Aug 3, 2018 · 1 comment
Open

dbk2man.py generates incorrect man pages #56

Mno-hime opened this issue Aug 3, 2018 · 1 comment

Comments

@Mno-hime
Copy link

Mno-hime commented Aug 3, 2018

I build man pages from zziplib 0.13.69 release via dbk2man.py on OpenIndiana and some of the generated man pages are incorrect. E.g. zzip_disk_buffer.3's content is

.so zzip_disk_mmap.3

but should be

.so man3/zzip_disk_mmap.3

man zzip_disk_buffer for the generated man pages says just: See the file zzip_disk_mmap.3. I believe we are using OpenBSD's mandoc as man(1). xmlto is generating man pages correctly.

Mno-hime added a commit to Mno-hime/oi-userland that referenced this issue Aug 3, 2018
There two ways to generate zziplib man pages and both have their
distinct problems. Man page generation via xmlto gets correct man pages
(with a docbook-xsl fix) but some man pages are not being generated,
plus xmlto way is to be deprecated in the future anyway. The other
method is via dbk2man.py but it generates correct amount of man pages
but they are broken in the same way xmlto-generated man pages are
without the docbook-xsl fix (filed
gdraheim/zziplib#56).

So, disable `xmlto` and manually fix incorrect man pages via `sed`.
Mno-hime added a commit to Mno-hime/oi-userland that referenced this issue Aug 3, 2018
There two ways to generate zziplib man pages and both have their
distinct problems. Man page generation via xmlto gets correct man pages
(with a docbook-xsl fix) but some man pages are not being generated,
plus xmlto way is to be deprecated in the future anyway. The other
method is via dbk2man.py but it generates correct amount of man pages
but they are broken in the same way xmlto-generated man pages are
without the docbook-xsl fix (filed
gdraheim/zziplib#56).

So, disable `xmlto` and manually fix incorrect man pages via `sed`.
@gdraheim
Copy link
Owner

A change to dbk2man.py generates ".so man3/xx" pages.

It should work as expected now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants