From 8d2305db25b3beba6fdff0b2dc034d367e8b09dd Mon Sep 17 00:00:00 2001
From: Konstantin Osipov <kostja@tarantool.org>
Date: Mon, 14 Apr 2014 14:05:23 +0400
Subject: [PATCH] Update the documentatio for master branch.
---
doc/www-data.in/_layout/base | 2 +-
doc/www-data.in/_text/faq.md | 21 +++++++++++-----
doc/www-data.in/download.cmake | 44 ++++++++++++++++++----------------
3 files changed, 39 insertions(+), 28 deletions(-)
diff --git a/doc/www-data.in/_layout/base b/doc/www-data.in/_layout/base
index 7271eed61a..5d3a92b88b 100644
--- a/doc/www-data.in/_layout/base
+++ b/doc/www-data.in/_layout/base
@@ -14,7 +14,7 @@
{% block header %}
<div id="blurb">
<h1><a href="/" class="index">Tarantool</a></h1>
- <h2>An in-memory NoSQL database</h2>
+ <h2>A NoSQL database in a Lua script</h2>
<h3>
<a href="intro.html" class="intro">Overview</a>
<a href="doc/stable/mpage/index.html" class="documentation">Documentation</a>
diff --git a/doc/www-data.in/_text/faq.md b/doc/www-data.in/_text/faq.md
index cdf5fd3609..c4f2061b20 100644
--- a/doc/www-data.in/_text/faq.md
+++ b/doc/www-data.in/_text/faq.md
@@ -19,9 +19,10 @@ faq:
**Q. What's the key advantage of Tarantool?**
- A. Tarantool provides a fairly rich core feature set (HASH, TREE BITSET
+ A. Tarantool provides a rich database feature set (HASH, TREE BITSET
indexes, secondary indexes, composite indexes, asynchronous replication,
- hot standby, data durability) along with support for Lua stored procedures.
+ hot standby, data durability) in a flexible environment of a Lua
+ interpreter.
These two properties make it possible to code fast, atomic and reliable
in-memory data servers which handle non-trivial application-specific logic.
The win over traditional SQL servers is in performance: low-overhead,
@@ -32,8 +33,9 @@ faq:
**Q. What are your development plans?**
- A. They are standard. Performance. Better support for transactions.
- Master-master replication, automatic sharding.
+ A. We continuously improve server performance. On the feature
+ front, automatic sharding and online upgrade are the two
+ major goals of 2014.
**Q. Who is developing Tarantool?**
@@ -48,9 +50,10 @@ faq:
and as such does not depend on any one sponsor. However, it is currently
and integral part of Mail.Ru backbone, so it gets a lot of support from Mail.ru.
- **Q. Why is Tarantool primary port number 33013?**
+ **Q. Why is Tarantool primary port number 3303?**
- A. It's a prime number which is easy to remember, because 3313, 3301, 313, 13 and 3 are also prime numbers.
+ A. It's a prime number which is easy to remember, because 3313,
+ 3301, 313, 13 and 3 are also prime numbers.
**Q. My arena_used/items_used in SHOW SLAB output is >> 1. What does it mean and what should I do?**
@@ -59,3 +62,9 @@ faq:
small tuples stored in the system initially, and later on each tuple becomes
bigger and doesn't fit into its old slab size. The old slabs are never
relinquished by the allocator. Currently this can be solved only by a server restart.
+
+ **Q. What happens when Tarantool runs out of memory?**
+
+ A. The server stops accepting updates until more memory is
+ available. Read and delete requests are served just fine.
+
diff --git a/doc/www-data.in/download.cmake b/doc/www-data.in/download.cmake
index 44e84c334e..46f990ba47 100644
--- a/doc/www-data.in/download.cmake
+++ b/doc/www-data.in/download.cmake
@@ -2,7 +2,8 @@ download:
main: |
# All downloads
- All published releases are available at [http://tarantool.org/dist].
+ All published releases are available at
+ [http://tarantool.org/dist/master].
# How to choose the right version for download
@@ -26,7 +27,7 @@ download:
The latest source archive is [tarantool-@PACKAGE_VERSION@-src.tar.gz]
Please consult with README for build instructions on your system.
- [tarantool-@PACKAGE_VERSION@-src.tar.gz]: http://tarantool.org/dist/tarantool-@PACKAGE_VERSION@-src.tar.gz
+ [tarantool-@PACKAGE_VERSION@-src.tar.gz]: http://tarantool.org/dist/master/tarantool-@PACKAGE_VERSION@-src.tar.gz
## Binary downloads
@@ -37,7 +38,8 @@ download:
### Debian GNU/Linux and Ubuntu
We maintain an always up-to-date Debian GNU/Linux and Ubuntu package
- repository at [http://tarantool.org/dist/debian] and [http://tarantool.org/dist/ubuntu]
+ repository at [http://tarantool.org/dist/master/debian] and
+ [http://tarantool.org/dist/master/ubuntu]
respectively.
At the moment the repository contains builds for Debian "Sid", "Jessie",
@@ -45,20 +47,20 @@ download:
It can be added to your apt sources list with:
```bash
- wget http://tarantool.org/dist/public.key
+ wget http://tarantool.org/dist/master/public.key
sudo apt-key add ./public.key
release=`lsb_release -c -s`
# For Debian:
cat > /etc/apt/sources.list.d/tarantool.list <<- EOF
- deb http://tarantool.org/dist/debian/ $release main
- deb-src http://tarantool.org/dist/debian/ $release main
+ deb http://tarantool.org/dist/master/debian/ $release main
+ deb-src http://tarantool.org/dist/master/debian/ $release main
EOF
# For Ubuntu:
cat > /etc/apt/sources.list.d/tarantool.list <<- EOF
- deb http://tarantool.org/dist/ubuntu/ $release main
- deb-src http://tarantool.org/dist/ubuntu/ $release main
+ deb http://tarantool.org/dist/master/ubuntu/ $release main
+ deb-src http://tarantool.org/dist/mater/ubuntu/ $release main
EOF
sudo apt-get update
@@ -67,7 +69,7 @@ download:
### CentOS 5-6 and RHEL 5-6
- CentOS repository is available at [http://tarantool.org/dist/centos]
+ CentOS repository is available at [http://tarantool.org/dist/master/centos]
Add the following section to your yum repository list (/etc/yum.repos.d/tarantool.repo)
to enable it:
@@ -75,14 +77,14 @@ download:
```ini
[tarantool]
name=CentOS-$releasever - Tarantool
- baseurl=http://tarantool.org/dist/centos/$releasever/os/$basearch/
+ baseurl=http://tarantool.org/dist/master/centos/$releasever/os/$basearch/
enabled=1
gpgcheck=0
```
### Fedora
- Fedora repository is available at [http://tarantool.org/dist/fedora]
+ Fedora repository is available at [http://tarantool.org/dist/master/fedora]
Add the following section to your yum repository list (/etc/yum.repos.d/tarantool.repo)
to enable it:
@@ -90,7 +92,7 @@ download:
```ini
[tarantool]
name=Fedora-$releasever - Tarantool
- baseurl=http://tarantool.org/dist/fedora/$releasever/os/$basearch/
+ baseurl=http://tarantool.org/dist/master/fedora/$releasever/os/$basearch/
enabled=1
gpgcheck=0
```
@@ -118,8 +120,8 @@ download:
</tr>
</table>
- [32-bit]: http://tarantool.org/dist/tarantool-@PACKAGE_VERSION@-linux-i686.tar.gz
- [64-bit]: http://tarantool.org/dist/tarantool-@PACKAGE_VERSION@-linux-x86_64.tar.gz
+ [32-bit]: http://tarantool.org/dist/master/tarantool-@PACKAGE_VERSION@-linux-i686.tar.gz
+ [64-bit]: http://tarantool.org/dist/master/tarantool-@PACKAGE_VERSION@-linux-x86_64.tar.gz
### FreeBSD
@@ -131,7 +133,7 @@ download:
You can install Tarantool using homebrew:
```
- $ brew install --use-clang http://tarantool.org/dist/tarantool.rb
+ $ brew install --use-clang http://tarantool.org/dist/master/tarantool.rb
```
Please upgrade `clang` to version 3.2 or later using
@@ -149,7 +151,7 @@ download:
[stable]: http://github.com/tarantool/tarantool/tree/stable
[master]: http://github.com/tarantool/tarantool/tree/master
[builds-m]: http://tarantool.org/dist/master
- [issues]: http://github.com/tarantool/tarantool/issues?labels=feature
+ [issues]: http://github.com/tarantool/tarantool/issues
## Connectors
@@ -162,11 +164,11 @@ download:
- Erlang driver, [https://github.com/rtsisyk/etarantool]
- C connector [is maintained in the server source tree](https://github.com/tarantool/tarantool/blob/master/connector/c)
- [http://tarantool.org/dist]: http://tarantool.org/dist
- [http://tarantool.org/dist/debian]: http://tarantool.org/dist/debian
- [http://tarantool.org/dist/ubuntu]: http://tarantool.org/dist/ubuntu
- [http://tarantool.org/dist/centos]: http://tarantool.org/dist/centos
- [http://tarantool.org/dist/fedora]: http://tarantool.org/dist/fedora
+ [http://tarantool.org/dist/master]: http://tarantool.org/dist/master
+ [http://tarantool.org/dist/master/debian]: http://tarantool.org/dist/master/debian
+ [http://tarantool.org/dist/master/ubuntu]: http://tarantool.org/dist/master/ubuntu
+ [http://tarantool.org/dist/master/centos]: http://tarantool.org/dist/master/centos
+ [http://tarantool.org/dist/master/fedora]: http://tarantool.org/dist/master/fedora
[https://github.com/mailru/tarantool-ruby]: https://github.com/mailru/tarantool-ruby
[http://pypi.python.org/pypi/tarantool]: http://pypi.python.org/pypi/tarantool
[https://github.com/tarantool/tarantool-php]: https://github.com/tarantool/tarantool-php
--
GitLab