Browse files

documentation fixes, fixes #82

  • Loading branch information...
1 parent e068632 commit 5d35fbaef9df4fe36c0743ccc8e49860979a4f10 @apollo13 apollo13 committed Aug 13, 2011
View
2 docs/guide/appendix/clients.rst
@@ -16,7 +16,7 @@ Clients
* `elastic_searchable <https://github.com/wireframe/elastic_searchable/>`_: Ruby client + Rails integration.
* `erlastic_search <http://github.com/tsloughter/erlastic_search>`_: Erlang client.
* `Elastica <http://github.com/ruflin/Elastica>`_: PHP client.
-* `elasitcsearch <http://github.com/nervetattoo/elasticsearch>`_ `_ PHP client.
+* `elasitcsearch <http://github.com/nervetattoo/elasticsearch>`_: PHP client.
* `NEST <https://github.com/Mpdreamz/NEST>`_: .NET client.
* `ElasticSearch.NET <https://github.com/medcl/ElasticSearch.Net>`_: .NET client.
View
2 docs/guide/reference/index-modules/cache.rst
@@ -16,7 +16,7 @@ The filter cache is responsible to cache the results of filters (used in the que
Node Filter Cache
-----------------
-The **node** filter cache allows to configure either a percentage (of the total memory allocated to the process) or an exact value of the cache used for filter cache. All shards allocated on that node will use this cache (thats why its called **node**`), and evicted based on LRU logic.
+The **node** filter cache allows to configure either a percentage (of the total memory allocated to the process) or an exact value of the cache used for filter cache. All shards allocated on that node will use this cache (thats why its called **node**), and evicted based on LRU logic.
The setting that allows to control the memory size for the filter cache is **indices.cache.filter.size** and it defaults to **20%**. *Note*, this is *not* an index level setting but a node level setting (can be configured in the node configuration).
View
8 docs/guide/reference/setup/installation.rst
@@ -13,15 +13,15 @@ After :ref:`downloading <es-guide-reference-setup-download>` the latest release
$ bin/elasticsearch
-Under *nix system, the command will start the process in the background. To run it in the foreground, add the -f switch to it:
+Under \*nix system, the command will start the process in the background. To run it in the foreground, add the -f switch to it:
.. code-block:: bash
$ bin/elasticsearch -f
-ElasticSearch is built using Java, and requires `Java 6 <http://java.sun.com/javase/downloads/index.jsp>`_ `_ in order to run. The version of Java that will be used can be set by setting the **JAVA_HOME** environment variable.
+ElasticSearch is built using Java, and requires `Java 6 <http://java.sun.com/javase/downloads/index.jsp>`_ in order to run. The version of Java that will be used can be set by setting the **JAVA_HOME** environment variable.
Environment Variables
=====================
@@ -35,8 +35,8 @@ Most times it is better to leave the default **JAVA_OPTS** as they are, and use
The **ES_MIN_MEM** and **ES_MAX_MEM** environment variables to set the minimum and maximum memory allocation for the JVM (set in mega bytes). It defaults to **256m** and **1g** respectively.
-*NIX
-----
+\*NIX
+-----
There are added features when using the **elasticsearch** shell script. The first, which was explained earlier, is the ability to easily run the process either in the foreground or the background.
View
12 docs/manual/installation.rst
@@ -6,13 +6,13 @@ Installation
You can install PyES either via the Python Package Index (PyPI)
or from source.
-To install using `pip`,::
+To install using `pip`,
.. code-block:: sh
$ pip install pyes
-To install using `easy_install`,::
+To install using `easy_install`,
.. code-block:: sh
@@ -26,7 +26,7 @@ Downloading and installing from source
Download the latest version of PyES from
http://pypi.python.org/pypi/pyes/
-You can install it by doing the following,::
+You can install it by doing the following,
.. code-block:: sh
@@ -40,15 +40,17 @@ You can install it by doing the following,::
Using the development version
-----------------------------
-You can clone the repository by doing the following::
+You can clone the repository by doing the following
.. code-block:: sh
$ git clone git://github.com/aparo/pyes.git
$ cd pyes
$ python setup.py develop
-To update, ::
+To update:
+
+.. code-block:: sh
$ cd pyes
$ git pull origin master

0 comments on commit 5d35fba

Please sign in to comment.