[Maria-developers] Rewrite of the free documentation to make it about MariaDB, not MySQL
![](https://secure.gravatar.com/avatar/769f0fd707751e8755eb9b5dd837ab63.jpg?s=120&d=mm&r=g)
Daniel I glanced through some of the commits today and noticed Kristian committing the new version of MySQL 5.1.38 documentation (man pages and other free docs). The docs seem to include lots of references to where you can download MySQL rpm's, where you can buy MySQL support, Suns support lifecycle policies, etc. As part of your documentation work, could you be in touch with Kristian and find out how you could help in cleaning that up. Meaning: Either remove such sections, or replace with relevant MariaDB information. While at it, I'd like to review the Readme file of MariaDB. Could you help me with that (ie extract it from bzr and work with me to rewrite it - so that I can just participate by email). The Readme file we should fix before GA release. The other docs are only semi-urgent. henrik -- email: henrik.ingo@avoinelama.fi tel: +358-40-5697354 www: www.avoinelama.fi/~hingo book: www.openlife.cc
![](https://secure.gravatar.com/avatar/4ae3ae2d37cd61bdf2ec02642a5100a7.jpg?s=120&d=mm&r=g)
On Wed, 16 Sep 2009 22:17:56 +0300, Henrik Ingo
![](https://secure.gravatar.com/avatar/769f0fd707751e8755eb9b5dd837ab63.jpg?s=120&d=mm&r=g)
On Thu, Sep 17, 2009 at 9:31 PM, Daniel Bartholomew
Henrik> While at it, I'd like to review the Readme file of MariaDB. Henrik> Could you help me with that (ie extract it from bzr and work Henrik> with me to rewrite it - so that I can just participate by Henrik> email).
The lp:~maria-captains/maria/maria-5.1-merge README contains the entire text of the lp:maria README plus a bunch of other stuff, including notices for various pieces of included software and the licenses those pieces of code use. Most of these notices are fairly short, but some are quite long (in the case of innochecksum.c, the entire text of the GPLv2 is included). I don't know if all of these notices are needed.
It seems they are needed for legal reasons (that's why MySQL keeps them here too). We should keep them, but there can be some whitespace between the "real text" and the when licenses start.
If there are any of these notices which can be removed, it would simplify the README. In the case of innochecksum.c in particular, if that notice is needed I think it would be better if we just point people to the COPYING file, which contains the GPLv2 text instead of putting a complete copy of GPLv2 in the README file.
Seems unnecessary yes, if it's GPL it's GPL. Maybe at this point it makes sense to keep the licenses identical to how they are in MySQL though. (The list is long even if removing GPL.)
To get things started, I've attached the two README files (named so you know which branch they come from). The additions are pretty easy to spot by just viewing the files side-by-side, even easier with a graphical diff viewer like meld.
Thanks. I've attached an edited version here. I've also attached a diff which should make clear what changes I made. The key changes is to write about MariaDB more as an independent product, not "a branch of MySQL", while still being a drop-in replacement. Other than that added links to MariaDB material and removed links to mysql.com. Monty, could you review.
Henrik> The Readme file we should fix before GA release. The other docs Henrik> are only semi-urgent.
Agree.
henrik -- email: henrik.ingo@avoinelama.fi tel: +358-40-5697354 www: www.avoinelama.fi/~hingo book: www.openlife.cc
![](https://secure.gravatar.com/avatar/06b8a7f236cf59aa9a83cab1a0551ca8.jpg?s=120&d=mm&r=g)
Hi!
"Henrik" == Henrik Ingo
writes:
Henrik> On Thu, Sep 17, 2009 at 9:31 PM, Daniel Bartholomew
![](https://secure.gravatar.com/avatar/769f0fd707751e8755eb9b5dd837ab63.jpg?s=120&d=mm&r=g)
Back from vacation, taking another stab at this.
On Mon, Oct 19, 2009 at 11:51 AM, Michael Widenius
Henrik> On Thu, Sep 17, 2009 at 9:31 PM, Daniel Bartholomew
wrote: Henrik> While at it, I'd like to review the Readme file of MariaDB. Henrik> Could you help me with that (ie extract it from bzr and work Henrik> with me to rewrite it - so that I can just participate by Henrik> email). <cut>
Henrik> Thanks. I've attached an edited version here. I've also attached a Henrik> diff which should make clear what changes I made. The key changes is Henrik> to write about MariaDB more as an independent product, not "a branch Henrik> of MySQL", while still being a drop-in replacement. Other than that Henrik> added links to MariaDB material and removed links to mysql.com.
Henrik> Monty, could you review.
I implemented all suggestions (easiest way :-), except:
-A local copy of the MySQL Reference Manual can be found in the Docs -directory in GNU Info format. You can also browse the manual online or -download it in any of several formats from -http://dev.mysql.com/doc
Keep the above. The distribution packages should include the MySQL manual, so the above is accurate.
I didn't check, but unless something changed I think the MySQL manual is *not* part of our packages currently? The reasons we once decided to omit it was that: - Most people browse the online docs anyway - MySQL manual is not Free so we may just as well learn to live without it - You are allowed to distribute the MySQL manual "disseminated together with the software", which is kind of true for MariaDB, but a hostile lawyer could argue that MariaDB is not MySQL, so we wouldn't fullfil that requirement. Attached is the edited version. Daniel, can you take ownership of this now. I'll comment by email if needed. (But don't expect to have anything to add.) henrik -- email: henrik.ingo@avoinelama.fi tel: +358-40-5697354 www: www.avoinelama.fi/~hingo book: www.openlife.cc
![](https://secure.gravatar.com/avatar/4ae3ae2d37cd61bdf2ec02642a5100a7.jpg?s=120&d=mm&r=g)
On Mon, 2 Nov 2009 16:54:52 +0200, Henrik Ingo
participants (3)
-
Daniel Bartholomew
-
Henrik Ingo
-
Michael Widenius