← Back to team overview

maria-developers team mailing list archive

Re: Information for release notes

 

Also posting this message to maria-discuss for those that might be
interested in the changelog, but are not subscribed to maria-developers.

On Thu, 24 Sep 2009 15:19:19 +0200, Kristian Nielsen
<knielsen@xxxxxxxxxxxxxxx> wrote:

Kristian> Hi Daniel,
Kristian> 
Kristian> Here is a rough changelog written from reading through bzr
Kristian> history.
Kristian> 
Kristian> I took a dump of every commit in MariaDB that is not in MySQL
Kristian> 5.1.38, and wrote this summary of the changes.
Kristian> 
Kristian> I don't have sufficient knowledge to parse through all of the
Kristian> Maria changes from before MariaDB started. Instead I wrote a
Kristian> generic entry for the Maria storage engine, and also added
Kristian> entries for what is already written (by Monty I think) on
Kristian> http://askmonty.org/wiki/index.php/MariaDB_versus_MySQL
Kristian> 
Kristian> So this is probably the best shot we have at a complete list
Kristian> of relevant differences between MySQL and MariaDB. Do let me
Kristian> know if anyone finds anything missing or any errors.
Kristian> 
Kristian> Daniel, I hope you can use this as the basis for the release
Kristian> notes.

This list helps a lot. Thanks!

Using the contents of the list, I have created a Changelog page on the
wiki:

http://askmonty.org/wiki/index.php/Manual:MariaDB_5.1_Changelog

I organized the page into two sections: Features, and Bug Fixes. I also
added links to the pages in the manual which exist for the changelog
entries refer to.

Kristian> Maybe this list will also be useful for you to fill out the
Kristian> Manual on the Wiki. I am thinking you could check that all
Kristian> new features are documented, and add pages for those that are
Kristian> not. If not trivial, you could just make a stub page and ask
Kristian> on maria-developers@ for someone to fill them out?

Stub pages for the manual are easy to create:

1. add a link to the new page to
   http://askmonty.org/wiki/index.php/Manual:Contents
2. click on the new link
3. enter the following text into the new page: {{stub}}
4. save the new stub page

To get things going, I created the following new stub pages for the
manual:

http://askmonty.org/wiki/index.php/Manual:Mysql_client_--abort-source-on-error

http://askmonty.org/wiki/index.php/Manual:XtraDB_storage_engine

http://askmonty.org/wiki/index.php/Manual:Character_Set_Conversion_performance

http://askmonty.org/wiki/index.php/Manual:CHECKSUM_TABLE_performance

Other stubs may need to be created, but I don't know which of the
remaining topics need documentation or not. For example, does the
entry about MariaDB NOT supporting NDB need it's own Manual page or
not?

Any contributions to the above stubs are *very* welcome. Any
contributions to any of the other refman pages are likewise welcome:

http://askmonty.org/wiki/index.php/Manual:Contents

Henrik> Could the list itself be a basis for a changelog document and
Henrik> then we make release notes into a more human readable document?
Henrik> I thought that was your intention yesterday on IRC?

The changelog page is a good compliment to the release notes page. The
changelog is brief and is presented as a series of bullet points. The
release notes page is longer with items presented as paragraphs in a
more readable way.

Thanks.

-- 
Daniel Bartholomew



Follow ups

References