[Rpm-maint] [rpm-software-management/rpm] Inconsistency in manpage formatting (Issue #2731)

[Frank Dana]

One thing I noticed, in building and browsing the documentation website locally (see #2259) is that there's some inconsistency in how the MarkDown source for the man pages is formatted. It slightly affects the manpage files themselves as they're output from `pandoc`, but it's far more noticeable in the HTML-converted versions.

For example, the `SEE ALSO` of `docs/man/rpmsign.8.md` is formatted:

https://github.com/rpm-software-management/rpm/blob/bbadc2bb6445e4608251d3b375120a02a8693286/docs/man/rpmsign.8.md?plain=1#L126-L135

But in `docs/man/rpmdeps.8.md`, it's:

https://github.com/rpm-software-management/rpm/blob/bbadc2bb6445e4608251d3b375120a02a8693286/docs/man/rpmdeps.8.md?plain=1#L65-L70

This leads to slightly different `man` output:
```console
$ gunzip < $(man -w rpmsign) | nroff -man
[...]
SEE ALSO
              popt(3),
              rpm(8),
              rpmdb(8),
              rpmkeys(8),
              rpm2cpio(8),
              rpmbuild(8),
              rpmspec(8),

$ gunzip < $(man -w rpmdeps) | nroff -man
[...]
SEE ALSO
       rpm(8),

       rpmbuild(8),
```

...but even more different HTML output.

I guess it would make sense to standardize the formatting, but the question becomes: What's the 'correct' way to format them?


-- 
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/issues/2731
You are receiving this because you are subscribed to this thread.

Message ID: <rpm-software-management/rpm/issues/2731 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rpm.org/pipermail/rpm-maint/attachments/20231023/b1887692/attachment-0001.html>