Uploaded image for project: 'MariaDB Server'
  1. MariaDB Server
  2. MDEV-748

LP:463756 - Need manual pages for maria utility programs

        Details

        • Type: Bug
        • Status: Open
        • Priority: Minor
        • Resolution: Unresolved
        • Affects Version/s: 5.1.67, 5.2.14, 5.3.12, 5.5.36, 10.0.9
        • Fix Version/s: 10.0, 5.5
        • Component/s: None
        • Labels:

          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.

            Gliffy Diagrams

              Attachments

                Activity

                Ascending order - Click to sort in descending order
                Hide
                Permalink
                ratzpo Rasmus Johansson added a comment -

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

                Show
                ratzpo Rasmus Johansson added a comment - Re: Need manual pages for maria utility programs I started http://git.thefuturegrid.org/?p=mariadb-manpgs;a=summary . Please provide feedback.
                Hide
                Permalink
                dbart Daniel Bartholomew added a comment -

                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)

                Show
                dbart Daniel Bartholomew added a comment - 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)
                Hide
                Permalink
                knielsen Kristian Nielsen added a comment -

                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.

                Show
                knielsen Kristian Nielsen added a comment - 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.
                Hide
                Permalink
                ratzpo Rasmus Johansson added a comment -

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

                Show
                ratzpo Rasmus Johansson added a comment - 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).
                Hide
                Permalink
                colin Colin Charles added a comment -

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

                Cheers!

                Show
                colin Colin Charles added a comment - Re: Need manual pages for maria utility programs Any progress on this, for mariadb-5.2? Cheers!
                Hide
                Permalink
                hakanküçükyılmaz Hakan Küçükyılmaz added a comment -

                Re: Need manual pages for maria utility programs
                Hi,

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

                Best,

                Hakan

                Show
                hakanküçükyılmaz Hakan Küçükyılmaz added a comment - Re: Need manual pages for maria utility programs Hi, what is the current status for this? Adam, Daniel? Best, Hakan
                Hide
                Permalink
                ratzpo Rasmus Johansson added a comment -

                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.

                Show
                ratzpo Rasmus Johansson added a comment - 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.
                Hide
                Permalink
                ratzpo Rasmus Johansson added a comment -

                Launchpad bug id: 463756

                Show
                ratzpo Rasmus Johansson added a comment - Launchpad bug id: 463756

                  People

                  • Assignee:
                    dbart Daniel Bartholomew
                    Reporter:
                    psergey Sergei Petrunia
                  • Votes:
                    0 Vote for this issue
                    Watchers:
                    1 Start watching this issue

                    Dates

                    • Created:
                      Updated: