Skip to content

Commit

Permalink
various documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Bartholomew committed Jun 18, 2012
1 parent 28f2c56 commit bdc68e5
Show file tree
Hide file tree
Showing 8 changed files with 59 additions and 42 deletions.
11 changes: 7 additions & 4 deletions BUILD-CMAKE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Copyright (c) 2009, 2010 Sun Microsystems, Inc.
Copyright (c) 2012 Monty Program Ab

How to Build MySQL server with CMake
How to Build MariaDB server with CMake

WHAT YOU NEED
---------------------------------------------------------------
Expand All @@ -11,7 +12,7 @@ HOW TO INSTALL:
Linux distributions:
shell> sudo apt-get install cmake

The above works on do Debian/Ubuntu based distributions.On others, command
The above works on Debian/Ubuntu based distributions. On others, the command
line needs to be modified to e.g "yum install" on Fedora or "zypper install"
on OpenSUSE.

Expand All @@ -20,8 +21,9 @@ shell> pfexec pkgadd install SUNWcmake

Windows and Mac OSX:
Download and install the latest distribution from
http://www.cmake.org/cmake/resources/software.html.On Windows, download
installer exe file and run it. On Mac, download the .dmg image and open it.
http://www.cmake.org/cmake/resources/software.html
On Windows, download installer exe file and run it. On MacOS, download
the .dmg image and open it.

Other Unixes:
Precompiled packages for other Unix flavors (HPUX, AIX) are available from
Expand Down Expand Up @@ -243,3 +245,4 @@ later corrected, the cached result is still used. If you encounter this
situation, which should be a rare occation, you need either to remove the
offending entry from CMakeCache.txt (if test was for HAVE_FOO, remove lines
containing HAVE_FOO from CMakeCache.txt) or just remove the cache file.

7 changes: 4 additions & 3 deletions Docs/mysql.info
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
MariaDB is in most aspects identical to MySQL.

Differences between MySQL and MariaDB can be found at:
http://askmonty.org/wiki/index.php/MariaDB_versus_MySQL
http://kb.askmonty.org/en/mariadb-versus-mysql-features/
http://kb.askmonty.org/en/mariadb-versus-mysql-compatibility/

The MariaDB references manual can be found at:
http://askmonty.org/wiki/index.php/Manual
The MariaDB manual can be found at:
http://kb.askmonty.org/

The MySQL Reference Manual is available in various formats on
http://dev.mysql.com/doc; if you're interested in the DocBook XML
Expand Down
11 changes: 11 additions & 0 deletions INSTALL-SOURCE
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
Installing and Upgrading MariaDB

This file contains chapter two of the MySQL manual and describes how
to obtain and install MySQL. The instructions below are generally
applicable to both MySQL and MariaDB, but differ in some particulars
(like, for example, the GPG signing key we use is different).

Detailed, MariaDB-specific instructions are available at:
http://kb.askmonty.org/en/getting-installing-and-upgrading-mariadb/

- - - -

Chapter 2. Installing and Upgrading MySQL

Expand Down
3 changes: 2 additions & 1 deletion INSTALL-WIN-SOURCE
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Up-to-date instructions on MariaDB building on Windows can be found in http://kb.askmonty.org/en/building-mariadb-on-windows.
Up-to-date instructions about building MariaDB on Windows can be found
at: http://kb.askmonty.org/en/building-mariadb-on-windows

50 changes: 25 additions & 25 deletions KNOWN_BUGS.txt
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
This file should contain all know fatal bugs in the Mariadb and the
Maria storage engine for the last source or binary release. Minor
bugs, extensions and feature request and bugs found since this release
can be find in the MariaDB bugs database at:
https://bugs.launchpad.net/maria and in the MySQL bugs databases at:
http://bugs.mysql.com/ (category "Maria storage engine").
This file should contain all known fatal bugs in Mariadb and the Aria
storage engine for the last source or binary release. Minor bugs,
extensions and feature requests, and bugs found since this release can
be found in the MariaDB bugs database at: http://mariadb.org/jira and
in the MySQL bugs databases at: http://bugs.mysql.com/ (category
"Maria storage engine").

There shouldn't normally be any bugs that affects normal operations in
any MariaDB release. Still, there are always exceptions and edge cases
and that's what this file is for.
There should not normally be any bugs which affect normal operations
in any MariaDB release. Still, there are always exceptions and edge
cases and that is what this file is for.

If you have found a bug that is not listed here, please add it to
http://bugs.launchpad.net/maria so that we can either fix it for next
release or in the worst case add it here for others to know!
http://mariadb.org/jira so we can either fix it for next release or in
the worst case add it here for others to know!


IMPORTANT:

If you have been using the Maria storage engine with
MySQL-5.1-Maria-alpha build and upgrading to a newer MariaDB you MUST
run maria_chk --recover on all your Maria tables. This is because we
made an incompatible change of how transaction id is stored and old
transaction id's must be reset!
If you have been using the Maria (now Aria) storage engine with the
MySQL-5.1-Maria-alpha build and are upgrading to a newer MariaDB you
MUST run [m]aria_chk --recover on all your Aria tables. This is because
we made an incompatible change with how the transaction id is stored
and old transaction id's must be reset!

cd mysql-data-directory
maria_chk --recover */*.MAI
aria_chk --recover */*.MAI

As the Maria storage engine is now in beta we will do our best to not
introduce any incompatible changes in the data format for the Maria
tables; If this would be ever be needed, we will, if possible, support
both the old and the new version to make upgrades as easy as possible.
Going forward, we will do our best to not introduce any incompatible
changes in the data format for Aria tables. If this would be ever be
needed, we will, if possible, support both the old and the new version
to make upgrades as easy as possible.

Note that for the MariaDB 5.1 release the Maria storage engine is
classified as 'beta'; It should work, but use it with caution. Please
report all bugs to https://bugs.launchpad.net/maria so that we can fix
them!
Note that for the MariaDB 5.1 release the Aria storage engine is
classified as 'beta'; It should work, but use it with caution. Please
report all bugs to http://mariadb.org/jira so we can fix them!
8 changes: 4 additions & 4 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ see the Credits appendix. You can also do 'SHOW authors' to get a
list of active contributors.

A description of the MariaDB project and a manual can be found at:
http://askmonty.org/wiki/index.php/MariaDB
http://askmonty.org/wiki/index.php/MariaDB_versus_MySQL
http://askmonty.org/wiki/index.php/Manual:Contents
http://kb.askmonty.org/
http://kb.askmonty.org/en/mariadb-versus-mysql-features/
http://kb.askmonty.org/en/mariadb-versus-mysql-compatibility/

As MariaDB is a full replacement of MySQL, the MySQL manual at
http://dev.mysql.com/doc is generally applicable.
Expand All @@ -41,7 +41,7 @@ EXCEPTIONS-CLIENT file.
IMPORTANT:

Bug and/or error reports regarding MariaDB should be submitted at
https://bugs.launchpad.net/maria
http://mariadb.org/jira

Bugs in the MySQL code can also be submitted at http://bugs.mysql.com

Expand Down
2 changes: 1 addition & 1 deletion client/mysql.cc
Original file line number Diff line number Diff line change
Expand Up @@ -2916,7 +2916,7 @@ com_help(String *buffer __attribute__((unused)),
}

put_info("\nGeneral information about MariaDB can be found at\n"
"http://askmonty.org/wiki/index.php/Manual:Contents\n", INFO_INFO);
"http://mariadb.org\n", INFO_INFO);
put_info("List of all MySQL commands:", INFO_INFO);
if (!named_cmds)
put_info("Note that all text commands must be first on line and end with ';'",INFO_INFO);
Expand Down
9 changes: 5 additions & 4 deletions scripts/mysql_install_db.sh
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,8 @@ then
echo "databases and anonymous user created by default. This is"
echo "strongly recommended for production servers."
echo
echo "See the MariaDB knowledge or the MySQL manual for more instructions."
echo "See the MariaDB Knowledgebase at http://kb.askmonty.org or the"
echo "MySQL manual for more instructions."

if test "$in_rpm" -eq 0
then
Expand All @@ -499,13 +500,13 @@ then
echo
echo "Please report any problems with the $scriptdir/mysqlbug script!"
echo
echo "The latest information about MariaDB is available at http://www.askmonty.org/."
echo "The latest information about MariaDB is available at http://mariadb.org/."
echo "You can find additional information about the MySQL part at:"
echo "http://dev.mysql.com"
echo "Support MariaDB development by buying support/new features from"
echo "Monty Program Ab. You can contact us about this at sales@askmonty.org".
echo "Monty Program Ab. You can contact us about this at sales@montyprogram.com".
echo "Alternatively consider joining our community based development effort:"
echo "http://askmonty.org/wiki/index.php/MariaDB#How_can_I_participate_in_the_development_of_MariaDB"
echo "http://kb.askmonty.org/en/contributing-to-the-mariadb-project/"
echo
fi

Expand Down

0 comments on commit bdc68e5

Please sign in to comment.