[MDEV-4187] Installation instructions in INSTALL.SOURCE Created: 2013-02-19  Updated: 2013-03-22  Resolved: 2013-03-22

Status: Closed
Project: MariaDB Server
Component/s: None
Affects Version/s: 10.0.1, 5.5.29
Fix Version/s: 10.0.2, 5.5.31

Type: Bug Priority: Major
Reporter: Juan Valentín-Pastrana Assignee: Daniel Bartholomew
Resolution: Fixed Votes: 0
Labels: None
Environment:

Linux source installation



 Description   

In file INSTALL.SOURCE, point 2.3.1. Source Installation Overview describes old MySQL installation process.

Might change:

  • use of cmake (instead of configure)
  • user can type "cmake . -LH" to show compilation options
  • user and group --> maria (instead of mysql)


 Comments   
Comment by Elena Stepanova [ 2013-02-19 ]

Hi Daniel,

I consider it a documentation request, please re-assign if needed.

user and group stay as is, but there are indeed many outdated points and a weird mix of Oracle/MariaDB.

Example of outdated points, just at the first glance:

MySQL 5.5 is the current development release series.
MySQL 5.1 is the current General Availability (Production)

Example of the weird mix:

Installing and Upgrading MariaDB
...
Normally, it is best
to use precompiled binary distributions of MySQL that are built
specifically for optimal performance on Windows by Oracle
Corporation.

Comment by Daniel Bartholomew [ 2013-02-26 ]

Part of the issue here is that the INSTALL-SOURCE file we have is from MySQL 5.1.x with an introductory section that I added back when we were still on MariaDB 5.1.x. The INSTALL-SOURCE file in MySQL source tarballs is just a copy-paste of Chapter 2 of the MySQL manual. The introductory section is our only addition.

There are four things we can do here:

1. remove Chapter 2 of the MySQL manual from the file and just point people at the knowledgebase.
2. update the file so that it includes the MySQL 5.5.x INSTALL-SOURCE file.
3. Start from scratch and copy the relevant KB page(s) into the file.
4. Do #2 and then go through the file paragraph by paragraph and update it with MariaDB specific instructions.

#1 and #2 are both very easy to do. #1 is what we do for the INSTALL-WIN-SOURCE file. #3 would not be too difficult either since it's just copy-pasting from the KB. The only issue there is to make sure to keep it updated with every release so that it has the latest information (something we would avoid if we went with #1). #4 would be the most difficult and I don't know how useful it would be either since we would basically be creating new, duplicate install docs.

I like option #1 best. The KB is where we keep our docs, and we should strongly encourage people to go there. Including chapter 2 of the MySQL manual made sense when we were getting started, especially since that's what MySQL does, but it just causes confusion now.

Any thoughts? Other options? Questions?

Comment by Elena Stepanova [ 2013-02-26 ]

I'm fine with #1, only maybe in addition to the KB link already existing in the file, it would make sense to add a more specific one (the one that is already there points at a high-level contents list "Getting, Installing, and Upgrading MariaDB").
This one looks closer: https://kb.askmonty.org/en/compiling-mariadb-from-source/

Comment by Daniel Bartholomew [ 2013-02-28 ]

serg, elenst, others: Is this change OK to push?

Comment by Sergei Golubchik [ 2013-03-01 ]

Yes, please go ahead!

Comment by Juan Valentín-Pastrana [ 2013-03-01 ]

As MariaDB is not including configure script anymore, installation must be made using cmake.
In https://kb.askmonty.org/en/compiling-mariadb-from-source/ I still find all references to configure, but some hint that newer versions use cmake (and just a link to http://www.cmake.org/)

I would be nice to find there that command to show all configuration options is:

$ cmake . -LH

and an example of how they should be entered, i.e.:

$ cmake . -DCMAKE_INSTALL_PREFIX:PATH=/usr/local/maria

Looking for that information hinders source installation

Comment by Juan Valentín-Pastrana [ 2013-03-01 ]

MySQL/Oracle information on this topic is quite extensive:

http://dev.mysql.com/doc/internals/en/cmake-howto-long-version.html

Comment by Vladislav Vaintroub [ 2013-03-01 ]

You can use MySQL/Oracle information, too It is actually too extensive. I think. It was not written by Oracle folks as end-user documentation, the initial purpose of this document was to introduce MySQL developers to the new tool, therefore it contains quite a lot of cmake basics, such as parameter discovery and CMAKE_INSTALL_PREFIX.

Comment by Daniel Bartholomew [ 2013-03-01 ]

Before closing this task I'll edit the https://kb.askmonty.org/en/compiling-mariadb-from-source/ to improve it.

Comment by Daniel Bartholomew [ 2013-03-22 ]

I've updated the following articles:

https://kb.askmonty.org/en/build-environment-setup-for-linux/

https://kb.askmonty.org/en/source-getting-the-mariadb-source-code/

https://kb.askmonty.org/en/generic-build-instructions/

Things are much improved documentation-wise, so closing.

Generated at Thu Feb 08 06:54:28 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.