diff --git a/doc/sphinx/dev_guide/building_from_source.rst b/doc/sphinx/dev_guide/building_from_source.rst index 98cc8d426c132dfe27d5534abb8b6253c0d06316..b88e0adfa8e4900575448ff3fa711d8799b92c94 100644 --- a/doc/sphinx/dev_guide/building_from_source.rst +++ b/doc/sphinx/dev_guide/building_from_source.rst @@ -31,7 +31,7 @@ explain what the steps are, then on the Internet you can look at some example sc * **gcc and g++, or clang** # see above * **git** # see above * **cmake** # see above - * **libreadline-dev or libreadline6-dev** # for interactive mode + * **libreadline-dev or libreadline6-dev or readline-devel** # for interactive mode * **autoconf** # optional, only in Mac OS scripts * **zlib1g** or **zlib** # optional, only in Mac OS scripts @@ -41,7 +41,8 @@ explain what the steps are, then on the Internet you can look at some example sc "Run the test suite" option in step 7. Say: |br| :codenormal:`python --version` |br| You should see that the python version is greater than 2.6 -- - preferably 2.7 -- and less than 3.0 + preferably 2.7 -- and less than 3.0. + It may be necessary to install python first. On Ubuntu you can get modules from the repository: @@ -54,7 +55,7 @@ explain what the steps are, then on the Internet you can look at some example sc # For documentation sudo apt-get install python-sphinx python-pelican python-beautifulsoup - On CentOS too you can get modules from the repository: + On CentOS 6 too you can get modules from the repository: .. code-block:: bash @@ -66,6 +67,9 @@ explain what the steps are, then on the Internet you can look at some example sc .. code-block:: bash + # On some machines this initial command may be necessary: + # wget https://bootstrap.pypa.io/ez_setup.py -O - | sudo python + # python module for parsing YAML (pyYAML): For test suite: # (If wget fails, check the http://pyyaml.org/wiki/PyYAML # to see what the current version is.) @@ -94,6 +98,9 @@ explain what the steps are, then on the Internet you can look at some example sc Finally, use Python :code:`pip` to bring in Python packages that may not be up-to-date in the distro repositories. + (On CentOS 7 it will be necessary to install pip first, + with :code:`sudo yum install epel-release` followed by + :code:`sudo yum install python-pip`.) .. code-block:: bash diff --git a/doc/sphinx/getting_started.rst b/doc/sphinx/getting_started.rst index e36f84a6353fd66dfc16c137de8c35e77ee48850..dcd45fad51dd3d626186cd17af5ee044f576abd9 100644 --- a/doc/sphinx/getting_started.rst +++ b/doc/sphinx/getting_started.rst @@ -72,7 +72,7 @@ variable which will contain the Debian version code e.g. "Wheezy": ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There is always an up-to-date Ubuntu repository at -http://tarantool.org/dist/master/ubuntu The repository contains builds for +http://tarantool.org/dist/master/ubuntu. The repository contains builds for Ubuntu 12.04 "precise", 13.10 "saucy", and 14.04 "trusty". Add the tarantool.org repository to your apt sources list. $release is an environment variable which will contain the Ubuntu version code e.g. "precise". If you want the version @@ -107,17 +107,15 @@ your x86 platform: * http://tarantool.org/dist/master/centos/7/os/x86_64 for version 7, x86-64 Add the following section to your yum repository list -(``/etc/yum.repos.d/tarantool.repo``) (in the following instructions, ``$releasever`` +(``/etc/yum.repos.d/tarantool.repo``) (in these instructions ``$releasever`` i.e. CentOS release version must be either 6 or 7 and ``$basearch`` i.e. base architecture must be either i386 or x86_64): -.. code-block:: ini - - # [tarantool] - name=CentOS-$releasever - Tarantool - baseurl=http://tarantool.org/dist/master/centos/$releasever/os/$basearch/ - enabled=1 - gpgcheck=0 + | :samp:`# [tarantool]` + | :samp:`name=CentOS-$releasever - Tarantool` + | :samp:`baseurl=http://tarantool.org/dist/master/centos/{$releasever}/os/{$basearch}/` + | :samp:`enabled=1` + | :samp:`gpgcheck=0` For example, if you have CentOS version 6 and x86-64, you can add the new section thus: @@ -131,6 +129,8 @@ For example, if you have CentOS version 6 and x86-64, you can add the new sectio echo "enabled=1" | sudo tee -a /etc/yum.repos.d/tarantool.repo echo "gpgcheck=0" | sudo tee -a /etc/yum.repos.d/tarantool.repo +Then install with :code:`sudo yum install tarantool`. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Fedora ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -138,17 +138,15 @@ For example, if you have CentOS version 6 and x86-64, you can add the new sectio These instructions are applicable for Fedora 19, 20 or rawhide. Pick the Fedora repository, for example http://tarantool.org/dist/master/fedora/20/x86_64 for version 20, x86-64. Add the following section to your yum repository list -(``/etc/yum.repos.d/tarantool.repo``) (in the following instructions, +(``/etc/yum.repos.d/tarantool.repo``) (in these instructions ``$releasever`` i.e. Fedora release version must be 19, 20 or rawhide and ``$basearch`` i.e. base architecture must be x86_64): -.. code-block:: ini - - [tarantool] - name=Fedora-$releasever - Tarantool - baseurl=http://tarantool.org/dist/master/fedora/$releasever$basearch/ - enabled=1 - gpgcheck=0 + | :samp:`[tarantool]` + | :samp:`name=Fedora-$releasever - Tarantool` + | :samp:`baseurl=http://tarantool.org/dist/master/fedora/{$releasever}/{$basearch}/` + | :samp:`enabled=1` + | :samp:`gpgcheck=0` For example, if you have Fedora version 20, you can add the new section thus: @@ -161,13 +159,14 @@ For example, if you have Fedora version 20, you can add the new section thus: sudo tee -a /etc/yum.repos.d/tarantool.repo echo "enabled=1" | sudo tee -a /etc/yum.repos.d/tarantool.repo echo "gpgcheck=0" | sudo tee -a /etc/yum.repos.d/tarantool.repo - Then install with sudo yum install tarantool. + +Then install with :code:`sudo yum install tarantool`. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Gentoo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -available from tarantool portage overlay. Use layman to add the overlay to your system: +There is a tarantool portage overlay. Use layman to add the overlay to your system: .. code-block:: bash