Merge lp:~dbart/maria/5.5-doc-updates into lp:maria/5.5

[Daniel Bartholomew]

This update replaces the old askmonty.org/wiki/... links scattered around in various files with links to the Knowledgebase or to mariadb.org (as appropriate). Also changed https://bugs.launchpad.net/maria links to http://mariadb.org/jira. Also added an explanatory introduction to the INSTALL-SOURCE file. Lastly, fixed some miscellaneous grammatical and punctuation errors in some text files.

Modified files are:
  BUILD-CMAKE
  INSTALL-SOURCE
  INSTALL-WIN-SOURCE
  KNOWN_BUGS.txt
  README
  client/mysql.cc
  Docs/mysql.info
  Docs/INSTALL-BINARY
  mysql-test/README
  scripts/mysql_install_db.sh
  sql/mysql_install_db.cc

[Sergei Golubchik (sergii)]

approved. please push!

review: Approve

=== modified file 'BUILD-CMAKE'
--- BUILD-CMAKE	2011-12-15 21:08:42 +0000
+++ BUILD-CMAKE	2012-06-18 21:42:22 +0000
@@ -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
 ---------------------------------------------------------------
@@ -11,7 +12,7 @@
 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.
 
@@ -20,8 +21,9 @@
 
 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 
@@ -243,3 +245,4 @@
 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.
+

=== modified file 'Docs/INSTALL-BINARY'
--- Docs/INSTALL-BINARY	2010-04-28 13:10:25 +0000
+++ Docs/INSTALL-BINARY	2012-06-18 21:42:22 +0000
@@ -31,7 +31,7 @@
        first.
 
    If you run into problems and need to file a bug report,
-   please report them to: http://bugs.launchpad.net/maria
+   please report them to: http://mariadb.org/jira
 
    See the instructions in Section 1.6, "How to Report Bugs or Problems."
 

=== modified file 'Docs/mysql.info'
--- Docs/mysql.info	2009-10-23 16:48:54 +0000
+++ Docs/mysql.info	2012-06-18 21:42:22 +0000
@@ -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

=== modified file 'INSTALL-SOURCE'
--- INSTALL-SOURCE	2012-04-10 06:28:13 +0000
+++ INSTALL-SOURCE	2012-06-18 21:42:22 +0000
@@ -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
 

=== modified file 'INSTALL-WIN-SOURCE'
--- INSTALL-WIN-SOURCE	2012-04-10 06:28:13 +0000
+++ INSTALL-WIN-SOURCE	2012-06-18 21:42:22 +0000
@@ -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
 

=== modified file 'KNOWN_BUGS.txt'
--- KNOWN_BUGS.txt	2009-09-03 14:05:38 +0000
+++ KNOWN_BUGS.txt	2012-06-18 21:42:22 +0000
@@ -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
-
-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.
-
-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!
+aria_chk --recover */*.MAI
+
+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 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!

=== modified file 'README'
--- README	2012-04-07 13:58:46 +0000
+++ README	2012-06-18 21:42:22 +0000
@@ -13,9 +13,9 @@
 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.
@@ -41,7 +41,7 @@
 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
 

=== modified file 'client/mysql.cc'
--- client/mysql.cc	2012-01-13 14:50:02 +0000
+++ client/mysql.cc	2012-06-18 21:42:22 +0000
@@ -2916,7 +2916,7 @@
   }
 
   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);

=== modified file 'mysql-test/README'
--- mysql-test/README	2011-02-24 00:36:32 +0000
+++ mysql-test/README	2012-06-18 21:42:22 +0000
@@ -69,10 +69,10 @@
 
 If you want to submit your test case you can send it 
 to [e-mail] or attach it to a bug report on
-https://bugs.launchpad.net/maria/.
+http://mariadb.org/jira/.
 
 If the test case is really big or if it contains 'not public' data,
 then put your .test file and .result file(s) into a tar.gz archive,
 add a README that explains the problem, ftp the archive to
-ftp://ftp.askmonty.org/private and send a mail to
-https://bugs.launchpad.net/maria/ about it.
+ftp://ftp.askmonty.org/private and submit a report to
+http://mariadb.org/jira about it.

=== modified file 'scripts/mysql_install_db.sh'
--- scripts/mysql_install_db.sh	2012-04-07 13:58:46 +0000
+++ scripts/mysql_install_db.sh	2012-06-18 21:42:22 +0000
@@ -484,7 +484,8 @@
   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
@@ -499,13 +500,13 @@
   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 [e-mail]".
+  echo "Monty Program Ab. You can contact us about this at [e-mail]".
   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
 

=== modified file 'sql/mysql_install_db.cc'
--- sql/mysql_install_db.cc	2012-04-16 13:28:33 +0000
+++ sql/mysql_install_db.cc	2012-06-18 21:42:22 +0000
@@ -119,8 +119,8 @@
    fprintf(stderr,
    "http://kb.askmonty.org/v/installation-issues-on-windows contains some help\n"
    "for solving the most common problems.  If this doesn't help you, please\n"
-   "leave a comment in the knowledge base or file a bug report at\n"
-   "https://bugs.launchpad.net/maria");
+   "leave a comment in the Knowledgebase or file a bug report at\n"
+   "http://mariadb.org/jira");
   }
   fflush(stderr);
   va_end(args);