Navigation Menu

Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
@kou
kou committed Apr 28, 2017
1 parent 48018c7 commit 75c1553
Show file tree
Hide file tree
Showing 93 changed files with 1,738 additions and 1,288 deletions.
567 changes: 321 additions & 246 deletions docs/genindex.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/install/centos.html
View file
Expand Up @@ -179,9 +179,9 @@ <h2>2.5.3. Build from source<a class="headerlink" href="#build-from-source" titl
</pre></div>
</div>
<p>Download source:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.1.tar.gz
% tar xvzf groonga-7.0.1.tar.gz
% cd groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.2.tar.gz
% tar xvzf groonga-7.0.2.tar.gz
% cd groonga-7.0.2
</pre></div>
</div>
<p>Configure (see <a class="reference internal" href="others.html#source-configure"><span class="std std-ref">configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/install/debian.html
View file
Expand Up @@ -171,9 +171,9 @@ <h2>2.3.2. Build from source<a class="headerlink" href="#build-from-source" titl
</pre></div>
</div>
<p>Download source:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.1.tar.gz
% tar xvzf groonga-7.0.1.tar.gz
% cd groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.2.tar.gz
% tar xvzf groonga-7.0.2.tar.gz
% cd groonga-7.0.2
</pre></div>
</div>
<p>Configure (see <a class="reference internal" href="others.html#source-configure"><span class="std std-ref">configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/install/fedora.html
View file
Expand Up @@ -163,9 +163,9 @@ <h2>2.6.2. Build from source<a class="headerlink" href="#build-from-source" titl
</pre></div>
</div>
<p>Download source:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.1.tar.gz
% tar xvzf groonga-7.0.1.tar.gz
% cd groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.2.tar.gz
% tar xvzf groonga-7.0.2.tar.gz
% cd groonga-7.0.2
</pre></div>
</div>
<p>Configure (see <a class="reference internal" href="others.html#source-configure"><span class="std std-ref">configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/install/mac_os_x.html
View file
Expand Up @@ -122,9 +122,9 @@ <h1>2.2. Mac OS X<a class="headerlink" href="#mac-os-x" title="Permalink to this
<h2>2.2.3. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline"></a></h2>
<p>Install <a class="reference external" href="https://developer.apple.com/xcode/">Xcode</a>.</p>
<p>Download source:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>% curl -O https://packages.groonga.org/source/groonga/groonga-7.0.1.tar.gz
% tar xvzf groonga-7.0.1.tar.gz
% cd groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>% curl -O https://packages.groonga.org/source/groonga/groonga-7.0.2.tar.gz
% tar xvzf groonga-7.0.2.tar.gz
% cd groonga-7.0.2
</pre></div>
</div>
<p>Configure (see <a class="reference internal" href="others.html#source-configure"><span class="std std-ref">configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/install/others.html
View file
Expand Up @@ -154,9 +154,9 @@ <h3>2.8.1.2. Libraries<a class="headerlink" href="#libraries" title="Permalink t
<h2>2.8.2. Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this headline"></a></h2>
<p>Groonga uses GNU build system. So the following is the simplest build
steps:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.1.tar.gz
% tar xvzf groonga-7.0.1.tar.gz
% cd groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.2.tar.gz
% tar xvzf groonga-7.0.2.tar.gz
% cd groonga-7.0.2
% ./configure
% make
% sudo make install
Expand Down
6 changes: 3 additions & 3 deletions docs/install/solaris.html
View file
Expand Up @@ -96,9 +96,9 @@ <h2>2.7.1. Oracle Solaris 11<a class="headerlink" href="#oracle-solaris-11" titl
</pre></div>
</div>
<p>Download source:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.1.tar.gz
% gtar xvzf groonga-7.0.1.tar.gz
% cd groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.2.tar.gz
% gtar xvzf groonga-7.0.2.tar.gz
% cd groonga-7.0.2
</pre></div>
</div>
<p>Configure with <code class="docutils literal"><span class="pre">CFLAGS=&quot;-m64&quot;</span> <span class="pre">CXXFLAGS=&quot;-m64&quot;</span></code> variables. They are
Expand Down
7 changes: 3 additions & 4 deletions docs/install/ubuntu.html
View file
Expand Up @@ -101,7 +101,6 @@ <h2>2.4.1. PPA (Personal Package Archive)<a class="headerlink" href="#ppa-person
<p>Here are supported Ubuntu versions:</p>
<blockquote>
<div><ul class="simple">
<li>12.04 LTS Precise Pangolin</li>
<li>14.04 LTS Trusty Tahr</li>
<li>16.04 LTS Xenial Xerus</li>
<li>16.10 Yakkety Yak</li>
Expand Down Expand Up @@ -166,9 +165,9 @@ <h2>2.4.2. Build from source<a class="headerlink" href="#build-from-source" titl
</pre></div>
</div>
<p>Download source:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.1.tar.gz
% tar xvzf groonga-7.0.1.tar.gz
% cd groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>% wget https://packages.groonga.org/source/groonga/groonga-7.0.2.tar.gz
% tar xvzf groonga-7.0.2.tar.gz
% cd groonga-7.0.2
</pre></div>
</div>
<p>Configure (see <a class="reference internal" href="others.html#source-configure"><span class="std std-ref">configure</span></a> about <code class="docutils literal"><span class="pre">configure</span></code> options):</p>
Expand Down
18 changes: 9 additions & 9 deletions docs/install/windows.html
View file
Expand Up @@ -100,15 +100,15 @@ <h2>2.1.1. Installer<a class="headerlink" href="#installer" title="Permalink to
packages.groonga.org:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.1-x86.exe">https://packages.groonga.org/windows/groonga/groonga-7.0.1-x86.exe</a></li>
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.2-x86.exe">https://packages.groonga.org/windows/groonga/groonga-7.0.2-x86.exe</a></li>
</ul>
</div></blockquote>
<p>Then run it.</p>
<p>For 64-bit environment, download x64 executable binary from
packages.goronga.org:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.1-x64.exe">https://packages.groonga.org/windows/groonga/groonga-7.0.1-x64.exe</a></li>
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.2-x64.exe">https://packages.groonga.org/windows/groonga/groonga-7.0.2-x64.exe</a></li>
</ul>
</div></blockquote>
<p>Then run it.</p>
Expand All @@ -121,15 +121,15 @@ <h2>2.1.2. zip<a class="headerlink" href="#zip" title="Permalink to this headlin
packages.groonga.org:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.1-x86.zip">https://packages.groonga.org/windows/groonga/groonga-7.0.1-x86.zip</a></li>
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.2-x86.zip">https://packages.groonga.org/windows/groonga/groonga-7.0.2-x86.zip</a></li>
</ul>
</div></blockquote>
<p>Then extract it.</p>
<p>For 64-bit environment, download x64 zip archive from
packages.groonga.org:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.1-x64.zip">https://packages.groonga.org/windows/groonga/groonga-7.0.1-x64.zip</a></li>
<li><a class="reference external" href="https://packages.groonga.org/windows/groonga/groonga-7.0.2-x64.zip">https://packages.groonga.org/windows/groonga/groonga-7.0.2-x64.zip</a></li>
</ul>
</div></blockquote>
<p>Then extract it.</p>
Expand All @@ -148,26 +148,26 @@ <h2>2.1.3. Build from source<a class="headerlink" href="#build-from-source" titl
<p>Download zipped source from packages.groonga.org:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference external" href="https://packages.groonga.org/source/groonga/groonga-7.0.1.zip">https://packages.groonga.org/source/groonga/groonga-7.0.1.zip</a></li>
<li><a class="reference external" href="https://packages.groonga.org/source/groonga/groonga-7.0.2.zip">https://packages.groonga.org/source/groonga/groonga-7.0.2.zip</a></li>
</ul>
</div></blockquote>
<p>Then extract it.</p>
<p>Move to the Groonga's source folder:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>&gt; cd c:\Users\%USERNAME%\Downloads\groonga-7.0.1
<div class="highlight-none"><div class="highlight"><pre><span></span>&gt; cd c:\Users\%USERNAME%\Downloads\groonga-7.0.2
</pre></div>
</div>
<p>Configure by <code class="docutils literal"><span class="pre">cmake</span></code>. The following commnad line is for 64-bit
version. To build 32-bit version, use <code class="docutils literal"><span class="pre">-G</span> <span class="pre">&quot;Visual</span> <span class="pre">Studio</span> <span class="pre">12</span> <span class="pre">2013&quot;</span></code>
parameter instead:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-7.0.1&gt; cmake . -G &quot;Visual Studio 12 2013 Win64&quot; -DCMAKE_INSTALL_PREFIX=C:\Groonga
<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-7.0.2&gt; cmake . -G &quot;Visual Studio 12 2013 Win64&quot; -DCMAKE_INSTALL_PREFIX=C:\Groonga
</pre></div>
</div>
<p>Build:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-7.0.1&gt; cmake --build . --config Release
<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-7.0.2&gt; cmake --build . --config Release
</pre></div>
</div>
<p>Install:</p>
<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-7.0.1&gt; cmake --build . --config Release --target Install
<div class="highlight-none"><div class="highlight"><pre><span></span>groonga-7.0.2&gt; cmake --build . --config Release --target Install
</pre></div>
</div>
<p>After the above steps, <a class="reference internal" href="../reference/executables/groonga.html"><span class="doc">groonga executable file</span></a> is found at
Expand Down
86 changes: 72 additions & 14 deletions docs/news.html
View file
Expand Up @@ -77,11 +77,64 @@ <h3>Navigation</h3>

<div class="section" id="news">
<h1>News<a class="headerlink" href="#news" title="Permalink to this headline"></a></h1>
<div class="section" id="release-7-0-1-2017-03-29">
<span id="release-7-0-1"></span><h2>Release 7.0.1 - 2017-03-29<a class="headerlink" href="#release-7-0-1-2017-03-29" title="Permalink to this headline"></a></h2>
<div class="section" id="release-7-0-2-2017-04-29">
<span id="release-7-0-2"></span><h2>Release 7.0.2 - 2017-04-29<a class="headerlink" href="#release-7-0-2-2017-04-29" title="Permalink to this headline"></a></h2>
<div class="section" id="improvements">
<h3>Improvements<a class="headerlink" href="#improvements" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>[<a class="reference internal" href="reference/commands/logical_select.html"><span class="doc">logical_select</span></a>] Supported multiple
<a class="reference internal" href="reference/commands/logical_select.html#logical-select-drilldowns-label-columns-name-window-sort-keys"><span class="std std-ref">drilldowns[${LABEL}].columns[${NAME}].window.sort_keys</span></a>
and
<a class="reference internal" href="reference/commands/logical_select.html#logical-select-drilldowns-label-columns-name-window-group-keys"><span class="std std-ref">drilldowns[${LABEL}].columns[${NAME}].window.group_keys</span></a>.</li>
<li>[windows] Updated bundled LZ4 to 1.7.5.</li>
<li>[cache] Supported persistent cache feature.</li>
<li>[<a class="reference internal" href="reference/commands/log_level.html"><span class="doc">log_level</span></a>] Update English documentation.</li>
<li>Added the following APIs:<ul>
<li><code class="docutils literal"><span class="pre">grn_set_default_cache_base_path()</span></code></li>
<li><code class="docutils literal"><span class="pre">grn_get_default_cache_base_path()</span></code></li>
<li><code class="docutils literal"><span class="pre">grn_persistent_cache_open()</span></code></li>
<li><code class="docutils literal"><span class="pre">grn_cache_default_open()</span></code></li>
</ul>
</li>
<li>[<a class="reference internal" href="reference/executables/groonga.html#cmdoption-groonga--cache-base-path"><code class="xref std std-option docutils literal"><span class="pre">groonga</span> <span class="pre">--cache-base-path</span></code></a>] Added a new option to use
persistent cache.</li>
<li>[<a class="reference internal" href="reference/executables/groonga-httpd.html"><span class="doc">groonga-httpd</span></a>]
[<a class="reference internal" href="reference/executables/groonga-httpd.html#groonga-httpd-groonga-cache-base-path"><span class="std std-ref">groonga_cache_base_path</span></a>] Added new
configuration to use persistent cache.</li>
<li>[windows] Updated bundled msgpack to 2.1.1.</li>
<li>[<a class="reference internal" href="reference/commands/object_inspect.html"><span class="doc">object_inspect</span></a>] Supported not only
column inspection, but also index column statistics.</li>
<li>Supported index search for &quot;<code class="docutils literal"><span class="pre">.*</span></code>&quot; regexp pattern. This feature is
enabled by default. Set
<code class="docutils literal"><span class="pre">GRN_SCAN_INFO_REGEXP_DOT_ASTERISK_ENABLE=no</span></code> environment variable
to disable this feature.</li>
<li>[<a class="reference internal" href="reference/functions/in_records.html"><span class="doc">in_records</span></a>] Added function to use an
existing table as condition patterns.</li>
<li>[<a class="reference internal" href="install/ubuntu.html"><span class="doc">Ubuntu</span></a>] Dropped Ubuntu 12.04 (Precise Pangolin)
support because of EOL.</li>
</ul>
</div>
<div class="section" id="fixes">
<h3>Fixes<a class="headerlink" href="#fixes" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>[<a class="reference internal" href="reference/commands/logical_select.html"><span class="doc">logical_select</span></a>] Fixed a bug that wrong
cache is used. This bug was occurred when dynamic column parameter
is used.</li>
<li>[<a class="reference internal" href="reference/commands/logical_select.html"><span class="doc">logical_select</span></a>] Fixed a bug that dynamic
columns aren't created. It's occurred when no match case.</li>
<li>[<a class="reference internal" href="reference/commands/reindex.html"><span class="doc">reindex</span></a>] Fixed a bug that data is lost
by reindex. [GitHub#646]</li>
<li>[httpd] Fixed a bug that response of <a class="reference internal" href="reference/commands/quit.html"><span class="doc">quit</span></a>
and <a class="reference internal" href="reference/commands/shutdown.html"><span class="doc">shutdown</span></a> is broken JSON when worker is
running as another user. [GitHub ranguba/groonga-client#12]</li>
</ul>
</div>
</div>
<div class="section" id="release-7-0-1-2017-03-29">
<span id="release-7-0-1"></span><h2>Release 7.0.1 - 2017-03-29<a class="headerlink" href="#release-7-0-1-2017-03-29" title="Permalink to this headline"></a></h2>
<div class="section" id="id1">
<h3>Improvements<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Exported the following API<ul>
<li>grn_ii_cursor_next_pos()</li>
<li>grn_table_apply_expr()</li>
Expand Down Expand Up @@ -158,8 +211,8 @@ <h3>Improvements<a class="headerlink" href="#improvements" title="Permalink to t
<code class="docutils literal"><span class="pre">drilldown_filter</span></code>.</li>
</ul>
</div>
<div class="section" id="fixes">
<h3>Fixes<a class="headerlink" href="#fixes" title="Permalink to this headline"></a></h3>
<div class="section" id="id2">
<h3>Fixes<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>[<a class="reference internal" href="reference/commands/lock_clear.html"><span class="doc">lock_clear</span></a>] Fixed a crash bug against
temporary database.</li>
Expand All @@ -184,8 +237,8 @@ <h3>Thanks<a class="headerlink" href="#thanks" title="Permalink to this headline
</div>
<div class="section" id="release-7-0-0-2017-02-09">
<span id="release-7-0-0"></span><h2>Release 7.0.0 - 2017-02-09<a class="headerlink" href="#release-7-0-0-2017-02-09" title="Permalink to this headline"></a></h2>
<div class="section" id="id1">
<h3>Improvements<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h3>Improvements<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>[<a class="reference internal" href="reference/functions/in_values.html"><span class="doc">in_values</span></a>] Supported sequential search
for reference vector column. [Patch by Naoya Murakami] [GitHub#629]</li>
Expand Down Expand Up @@ -229,8 +282,8 @@ <h3>Improvements<a class="headerlink" href="#id1" title="Permalink to this headl
<li>[httpd] Updated bundled nginx to 1.11.9.</li>
</ul>
</div>
<div class="section" id="id2">
<h3>Fixes<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<div class="section" id="id4">
<h3>Fixes<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Fixed a bug that nonexistent sort keys for <code class="docutils literal"><span class="pre">drilldowns[LABEL]</span></code> or
<code class="docutils literal"><span class="pre">slices[LABEL]</span></code> causes invalid JSON parse error. [Patch by Naoya
Expand All @@ -247,8 +300,8 @@ <h3>Fixes<a class="headerlink" href="#id2" title="Permalink to this headline">¶
passed. [GitHub#634][Patch by Naoya Murakami]</li>
</ul>
</div>
<div class="section" id="id3">
<h3>Thanks<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<div class="section" id="id5">
<h3>Thanks<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li>Naoya Murakami</li>
<li>aomi-n</li>
Expand Down Expand Up @@ -408,16 +461,21 @@ <h2>The old releases<a class="headerlink" href="#the-old-releases" title="Permal
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">News</a><ul>
<li><a class="reference internal" href="#release-7-0-1-2017-03-29">Release 7.0.1 - 2017-03-29</a><ul>
<li><a class="reference internal" href="#release-7-0-2-2017-04-29">Release 7.0.2 - 2017-04-29</a><ul>
<li><a class="reference internal" href="#improvements">Improvements</a></li>
<li><a class="reference internal" href="#fixes">Fixes</a></li>
<li><a class="reference internal" href="#thanks">Thanks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#release-7-0-0-2017-02-09">Release 7.0.0 - 2017-02-09</a><ul>
<li><a class="reference internal" href="#release-7-0-1-2017-03-29">Release 7.0.1 - 2017-03-29</a><ul>
<li><a class="reference internal" href="#id1">Improvements</a></li>
<li><a class="reference internal" href="#id2">Fixes</a></li>
<li><a class="reference internal" href="#id3">Thanks</a></li>
<li><a class="reference internal" href="#thanks">Thanks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#release-7-0-0-2017-02-09">Release 7.0.0 - 2017-02-09</a><ul>
<li><a class="reference internal" href="#id3">Improvements</a></li>
<li><a class="reference internal" href="#id4">Fixes</a></li>
<li><a class="reference internal" href="#id5">Thanks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#the-old-releases">The old releases</a></li>
Expand Down

0 comments on commit 75c1553

Please sign in to comment.