Need manual pages for maria utility programs

Bug #463756 reported by Sergey Petrunia
10
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MariaDB
Confirmed
Medium
Daniel Bartholomew

Bug 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.

Changed in maria:
importance: Undecided → Medium
Revision history for this message
Adam M Dutko (styluseater) wrote :
Revision history for this message
Daniel Bartholomew (dbart) wrote :

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)

Changed in maria:
status: New → Confirmed
tags: added: 5.1 documentation
Changed in maria:
assignee: nobody → Daniel Bartholomew (dbart)
Revision history for this message
Kristian Nielsen (knielsen) wrote :

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.

tags: removed: 5.1
Revision history for this message
Adam M Dutko (styluseater) wrote :

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).

Revision history for this message
Colin Charles (ccharles) wrote :

Any progress on this, for mariadb-5.2?

Cheers!

Revision history for this message
Hakan Küçükyılmaz (hakan-askmonty) wrote :

Hi,

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

Best,

Hakan

Revision history for this message
Adam M Dutko (styluseater) wrote :

Hakan, I just created lp:~styluseater/maria/bug_463756 to start putting more content into to help resolve this bug.

Changed in maria:
milestone: none → 5.1
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.