[MDEV-748] LP:463756 - Need manual pages for maria utility programs Created: 2009-10-29  Updated: 2017-03-06  Resolved: 2017-03-06

Status: Closed
Project: MariaDB Server
Component/s: Documentation
Affects Version/s: 5.1.67, 5.2.14, 5.3.12, 5.5.36, 10.0.9
Fix Version/s: N/A

Type: Bug Priority: Minor
Reporter: Sergei Petrunia Assignee: Daniel Bartholomew
Resolution: Fixed Votes: 0
Labels: Launchpad

Attachments: XML File LPexportBug463756.xml    

 Description   

Maria storage engine comes with several utilities (maria_chk maria_dump_log maria_ftdump maria_pack maria_read_log). We do not have manual pages for them.

There is not much documentation: (--help messages and http://dev.mysql.com/doc/refman/5.1-maria/en/se-maria-tools.html) but we still should create manual pages.

 Comments   
Comment by Rasmus Johansson (Inactive) [ 2009-11-08 ]

Re: Need manual pages for maria utility programs
I started http://git.thefuturegrid.org/?p=mariadb-manpgs;a=summary . Please provide feedback.

Comment by Daniel Bartholomew [ 2009-11-12 ]

Re: Need manual pages for maria utility programs
This looks good. Some of the information in the individual man pages needs to be fleshed out, but the basics are there. The developers on the maria-developers list or on the #maria IRC channel on freenode can help you have questions about the various options for the utilities or who wrote them.

Would it be possible for you to put these files into your own branch of MariaDB on launchpad? That will make getting it included into MariaDB easier. See http://askmonty.org/wiki/index.php/Contributing_Code (specifically the "Getting the Maria Code", "Publish your branch", and "Propose branch" sections) for some help on this if you are unsure. These man files should be placed into the man/ directory of the source tree.

Thanks! (and let me know if you have questions about my comments)

Comment by Kristian Nielsen [ 2010-01-12 ]

Re: Need manual pages for maria utility programs
We of course really really want to have manual pages for the maria utilities.
However, given that the maria storage engine is not a priority currently for 5.1, I do not think it should be a blocking bug for 5.1 -> I removed 5.1 tag.

Comment by Rasmus Johansson (Inactive) [ 2010-01-15 ]

Re: Need manual pages for maria utility programs
Daniel ... sorry for the very late reply. I've been distracted with a few other things. I'm finally setup on launchpad so I will make a branch, finish the manuals to a point where they can be reviewed, then notify everyone in the channel when they're ready for review. I hope to have more of them finished by the end of this weekend (01/16 and 01/17 of 2010).

Comment by Colin Charles [ 2010-03-07 ]

Re: Need manual pages for maria utility programs
Any progress on this, for mariadb-5.2?

Cheers!

Comment by Hakan Küçükyılmaz (Inactive) [ 2010-05-25 ]

Re: Need manual pages for maria utility programs
Hi,

what is the current status for this? Adam, Daniel?

Best,

Hakan

Comment by Rasmus Johansson (Inactive) [ 2010-08-01 ]

Re: Need manual pages for maria utility programs
Hakan, I just created lp:~styluseater/maria/bug_463756 to start putting more content into to help resolve this bug.

Comment by Rasmus Johansson (Inactive) [ 2010-11-30 ]

Launchpad bug id: 463756

Comment by Daniel Bartholomew [ 2017-03-06 ]

The man pages were added a while back, but this MDEV was never closed. Closing now.

Generated at Thu Feb 08 06:31:03 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.