[MDEV-5485] Minor man pages formatting issues Created: 2013-12-22  Updated: 2014-06-02  Resolved: 2014-06-02

Status: Closed
Project: MariaDB Server
Component/s: None
Affects Version/s: 5.1.67, 5.2.14, 5.3.12, 5.5.36, 10.0.10
Fix Version/s: 5.5.38, 10.0.12

Type: Bug Priority: Trivial
Reporter: Otto Kekäläinen Assignee: Sergei Golubchik
Resolution: Fixed Votes: 0
Labels: debian, packaging

Sprint: serg-test-sprint-1

 Description   

While packaging MariaDB I noticed that there are some minor issues in man pages:

Syntax errors:

mariadb-client-5.5: manpage-has-errors-from-man usr/share/man/man1/mysqladmin.1.gz 28: warning [p 1, 1.5i]: can't break line
mariadb-client-5.5: manpage-has-errors-from-man usr/share/man/man1/mysqldump.1.gz 2047: warning [p 12, 1.3i, div `3tbd2,1', 0.2i]: can't break line
mariadb-client-5.5: manpage-has-errors-from-man usr/share/man/man8/mysqlmanager.8.gz 1509: warning [p 11, 4.8i, div `3tbd7,1', 5.2i]: can't break line
mariadb-server-5.5: manpage-has-errors-from-man usr/share/man/man1/mysqlbinlog.1.gz 1313: warning [p 9, 1.8i, div `3tbd3,2', 0.8i]: can't break line

The above should be trivial to fix.

Missing man pages:

mariadb-server-5.5: binary-without-manpage usr/bin/aria_chk
mariadb-server-5.5: binary-without-manpage usr/bin/aria_dump_log
mariadb-server-5.5: binary-without-manpage usr/bin/aria_ftdump
mariadb-server-5.5: binary-without-manpage usr/bin/aria_pack
mariadb-server-5.5: binary-without-manpage usr/bin/aria_read_log
mariadb-server-5.5: binary-without-manpage usr/bin/mysql_plugin
mariadb-client-5.5: binary-without-manpage usr/bin/innochecksum
mariadb-client-5.5: binary-without-manpage usr/bin/mysqlanalyze
mariadb-client-5.5: binary-without-manpage usr/bin/mysqloptimize
mariadb-client-5.5: binary-without-manpage usr/bin/mysqlrepair

The tool help2man (https://www.gnu.org/software/help2man/) might be useful here to quickly create at least some kind of man pages for where they are missing. If some binary is a link to another program, it would be good to have it documented somewhere in the sources.



 Comments   
Comment by Elena Stepanova [ 2014-04-12 ]

At least a part of these messages is true, we don't have manpages for aria* tools.

However, it looks like we have one for mysql_plugin, or for innochecksum; and things like mysqlanalyze must be just links to mysqlcheck, for which we do have a manpage.

Comment by Rasmus Johansson (Inactive) [ 2014-05-05 ]

Ian,

Is this something you could take a look at?

Generated at Thu Feb 08 07:04:45 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.