https://bugzilla.redhat.com/show_bug.cgi?id=2486105
--- Comment #3 from Georg Sauthoff <[email protected]> --- Thank you for your review! I've considered those documentation files. The 'master' files are the markdown files, i.e. from those the man pages and html files are generated. The main package currently installs: /usr/share/man/man1/djbsort-fulltest.1.gz /usr/share/man/man1/djbsort-speed.1.gz /usr/share/man/man1/djbsort-test.1.gz /usr/share/doc/libdjbsort/readme.md /usr/share/doc/libdjbsort/security.md /usr/share/licenses/libdjbsort/license.md The devel currently installs: /usr/share/man/man3/djbsort.3.gz which is generated from doc/api.md. Thus, the packages currently exclude: doc/changes.md -> moved to download doc/comparison.md -> comparison with other sorting libraries, better suited for a paper/article, arguably doc/download.md -> basically the download page with a bit of changelog doc/install.md -> only relevant when building the library from source doc/internals.md -> arguably only relevant when hacking on the library itself doc/refs.md -> extensive references, arguably only relevant when reviewing internals and benchmarks doc/speed.md -> benchmark page where the plots are online doc/verif.md -> only relevant if you are interested in the formal verification of the sort functions So my rationale is to prefer man pages over markdown, include markdown files that add to man pages and provide information that is useful to a 'typical' user over the library and avoid redundant files (in different formats). I'm open to add more doc files if there is strong demand, but currently I feel that it's a balanced selection. --- I'll check your review links. -- You are receiving this mail because: You are on the CC list for the bug. You are always notified about changes to this product and component https://bugzilla.redhat.com/show_bug.cgi?id=2486105 Report this comment as SPAM: https://bugzilla.redhat.com/enter_bug.cgi?product=Bugzilla&format=report-spam&short_desc=Report%20of%20Bug%202486105%23c3 -- _______________________________________________ package-review mailing list -- [email protected] To unsubscribe send an email to [email protected] Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/[email protected] Do not reply to spam, report it: https://forge.fedoraproject.org/infra/tickets/issues/new
