Update documents

groonga · Apr 5, 2017 · 4989852 · 4989852
1 parent 8d42804
commit 4989852
Show file tree

Hide file tree

Showing 8 changed files with 210 additions and 64 deletions.
diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/reference/commands/log_level.html b/docs/reference/commands/log_level.html
@@ -90,9 +90,7 @@ <h3>Navigation</h3>
 <h1>7.3.28. <code class="docutils literal"><span class="pre">log_level</span></code><a class="headerlink" href="#log-level" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="summary">
 <h2>7.3.28.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
-<p>log_level - ログ出力レベルの設定</p>
-<p>Groonga組込コマンドの一つであるlog_levelについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。</p>
-<p>log_levelは、ログ出力レベルを設定します。</p>
+<p><code class="docutils literal"><span class="pre">log_level</span></code> command sets log level of Groonga.</p>
 </div>
 <div class="section" id="syntax">
 <h2>7.3.28.2. Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
@@ -111,26 +109,72 @@ <h2>7.3.28.3. Usage<a class="headerlink" href="#usage" title="Permalink to this
 <h2>7.3.28.4. Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
 <p><code class="docutils literal"><span class="pre">level</span></code></p>
 <blockquote>
-<div><p>設定するログ出力レベルの値を以下のいずれかで指定します。</p>
-<blockquote>
-<div>EMERG
-ALERT
-CRIT
+<div><p>Specify log level with a character or string which means log level.</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Value</th>
+<th class="head">Alias</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">E</span></code></td>
+<td><code class="docutils literal"><span class="pre">emerge</span></code> or <code class="docutils literal"><span class="pre">emergency</span></code></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">A</span></code></td>
+<td><code class="docutils literal"><span class="pre">alert</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">C</span></code></td>
+<td><code class="docutils literal"><span class="pre">crit</span></code> or <code class="docutils literal"><span class="pre">critical</span></code></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">e</span></code></td>
+<td><code class="docutils literal"><span class="pre">error</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">w</span></code></td>
+<td><code class="docutils literal"><span class="pre">warn</span></code> or <code class="docutils literal"><span class="pre">warning</span></code></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">n</span></code></td>
+<td><code class="docutils literal"><span class="pre">notice</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">i</span></code></td>
+<td><code class="docutils literal"><span class="pre">info</span></code></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">d</span></code></td>
+<td><code class="docutils literal"><span class="pre">debug</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">-</span></code></td>
+<td><code class="docutils literal"><span class="pre">dump</span></code></td>
+</tr>
+</tbody>
+</table>
+<p>Example:</p>
+<div class="highlight-none"><div class="highlight"><pre><span></span>emergency
+alert
+critical
 error
 warning
 notice
 info
-debug</div></blockquote>
+debug
+</pre></div>
+</div>
 </div></blockquote>
 </div>
 <div class="section" id="return-value">
 <h2>7.3.28.5. Return value<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
-<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ]
+<p><code class="docutils literal"><span class="pre">log_level</span></code> command returns whether log level configuration is succeeded or not:</p>
+<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT]
 </pre></div>
 </div>
-<p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p>
+<p><code class="docutils literal"><span class="pre">HEADER</span></code></p>
+<blockquote>
+<div>See <a class="reference internal" href="../command/output_format.html"><span class="doc">Output format</span></a> about <code class="docutils literal"><span class="pre">HEADER</span></code>.</div></blockquote>
+<p><code class="docutils literal"><span class="pre">SUCCEEDED_OR_NOT</span></code></p>
 <blockquote>
-<div>エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。</div></blockquote>
+<div>If command succeeded, it returns true, otherwise it returns false on error.</div></blockquote>
 </div>
 <div class="section" id="see-also">
 <h2>7.3.28.6. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/sources/reference/commands/log_level.txt b/docs/sources/reference/commands/log_level.txt
@@ -8,11 +8,7 @@
 Summary
 -------
 
-log_level - ログ出力レベルの設定
-
-Groonga組込コマンドの一つであるlog_levelについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-log_levelは、ログ出力レベルを設定します。
+``log_level`` command sets log level of Groonga.
 
 Syntax
 ------
@@ -32,27 +28,57 @@ Parameters
 
 ``level``
 
-  設定するログ出力レベルの値を以下のいずれかで指定します。
-
-     EMERG
-     ALERT
-     CRIT
-     error
-     warning
-     notice
-     info
-     debug
+  Specify log level with a character or string which means log level.
+
+  .. list-table::
+     :header-rows: 1
+
+     * - Value
+       - Alias
+     * - ``E``
+       - ``emerge`` or ``emergency``
+     * - ``A``
+       - ``alert``
+     * - ``C``
+       - ``crit`` or ``critical``
+     * - ``e``
+       - ``error``
+     * - ``w``
+       - ``warn`` or ``warning``
+     * - ``n``
+       - ``notice``
+     * - ``i``
+       - ``info``
+     * - ``d``
+       - ``debug``
+     * - ``-``
+       - ``dump``
+
+  Example::
+
+       emergency
+       alert
+       critical
+       error
+       warning
+       notice
+       info
+       debug
 
 Return value
 ------------
 
-::
+``log_level`` command returns whether log level configuration is succeeded or not::
+
+  [HEADER, SUCCEEDED_OR_NOT]
+
+``HEADER``
 
- [成功かどうかのフラグ]
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
-``成功かどうかのフラグ``
+``SUCCEEDED_OR_NOT``
 
-  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+  If command succeeded, it returns true, otherwise it returns false on error.
 
 See also
 --------

diff --git a/ja/docs/objects.inv b/ja/docs/objects.inv
diff --git a/ja/docs/reference/commands/log_level.html b/ja/docs/reference/commands/log_level.html
@@ -91,9 +91,7 @@ <h3>ナビゲーション</h3>
 <h1>7.3.28. <code class="docutils literal"><span class="pre">log_level</span></code><a class="headerlink" href="#log-level" title="このヘッドラインへのパーマリンク">¶</a></h1>
 <div class="section" id="summary">
 <h2>7.3.28.1. 概要<a class="headerlink" href="#summary" title="このヘッドラインへのパーマリンク">¶</a></h2>
-<p>log_level - ログ出力レベルの設定</p>
-<p>Groonga組込コマンドの一つであるlog_levelについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。</p>
-<p>log_levelは、ログ出力レベルを設定します。</p>
+<p><code class="docutils literal"><span class="pre">log_level</span></code> コマンドはGroongaのログレベルを設定します。</p>
 </div>
 <div class="section" id="syntax">
 <h2>7.3.28.2. 構文<a class="headerlink" href="#syntax" title="このヘッドラインへのパーマリンク">¶</a></h2>
@@ -112,26 +110,78 @@ <h2>7.3.28.3. 使い方<a class="headerlink" href="#usage" title="このヘッ
 <h2>7.3.28.4. 引数<a class="headerlink" href="#parameters" title="このヘッドラインへのパーマリンク">¶</a></h2>
 <p><code class="docutils literal"><span class="pre">level</span></code></p>
 <blockquote>
-<div><p>設定するログ出力レベルの値を以下のいずれかで指定します。</p>
-<blockquote>
-<div>EMERG
-ALERT
-CRIT
+<div><p>ログレベル（1文字）もしくはログレベルを表す文字列を指定します。</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="50%" />
+<col width="50%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Value</th>
+<th class="head"><p class="first last">エイリアス</p>
+</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">E</span></code></td>
+<td><p class="first last"><code class="docutils literal"><span class="pre">emerge</span></code> もしくは <code class="docutils literal"><span class="pre">emergency</span></code></p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">A</span></code></td>
+<td><code class="docutils literal"><span class="pre">alert</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">C</span></code></td>
+<td><p class="first last"><code class="docutils literal"><span class="pre">crit</span></code> もしくは <code class="docutils literal"><span class="pre">critical</span></code></p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">e</span></code></td>
+<td><code class="docutils literal"><span class="pre">error</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">w</span></code></td>
+<td><p class="first last"><code class="docutils literal"><span class="pre">warn</span></code> もしくは <code class="docutils literal"><span class="pre">warning</span></code></p>
+</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">n</span></code></td>
+<td><code class="docutils literal"><span class="pre">notice</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">i</span></code></td>
+<td><code class="docutils literal"><span class="pre">info</span></code></td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">d</span></code></td>
+<td><code class="docutils literal"><span class="pre">debug</span></code></td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">-</span></code></td>
+<td><code class="docutils literal"><span class="pre">dump</span></code></td>
+</tr>
+</tbody>
+</table>
+<p>実行例:</p>
+<div class="highlight-none"><div class="highlight"><pre><span></span>emergency
+alert
+critical
 error
 warning
 notice
 info
-debug</div></blockquote>
+debug
+</pre></div>
+</div>
 </div></blockquote>
 </div>
 <div class="section" id="return-value">
 <h2>7.3.28.5. 戻り値<a class="headerlink" href="#return-value" title="このヘッドラインへのパーマリンク">¶</a></h2>
-<div class="highlight-none"><div class="highlight"><pre><span></span>[成功かどうかのフラグ]
+<p><code class="docutils literal"><span class="pre">log_level</span></code> コマンドはログレベルの設定に成功したかどうかを返します。:</p>
+<div class="highlight-none"><div class="highlight"><pre><span></span>[HEADER, SUCCEEDED_OR_NOT]
 </pre></div>
 </div>
-<p><code class="docutils literal"><span class="pre">成功かどうかのフラグ</span></code></p>
+<p><code class="docutils literal"><span class="pre">HEADER</span></code></p>
 <blockquote>
-<div>エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。</div></blockquote>
+<div><p><code class="docutils literal"><span class="pre">HEADER</span></code> については <a class="reference internal" href="../command/output_format.html"><span class="doc">出力形式</span></a> を参照してください。</p>
+</div></blockquote>
+<p><code class="docutils literal"><span class="pre">SUCCEEDED_OR_NOT</span></code></p>
+<blockquote>
+<div><p>コマンドの実行が成功するとtrueを返します。失敗するとエラーとしてfalseを返します。</p>
+</div></blockquote>
 </div>
 <div class="section" id="see-also">
 <h2>7.3.28.6. 参考<a class="headerlink" href="#see-also" title="このヘッドラインへのパーマリンク">¶</a></h2>

diff --git a/ja/docs/searchindex.js b/ja/docs/searchindex.js
diff --git a/ja/docs/sources/reference/commands/log_level.txt b/ja/docs/sources/reference/commands/log_level.txt
@@ -8,11 +8,7 @@
 Summary
 -------
 
-log_level - ログ出力レベルの設定
-
-Groonga組込コマンドの一つであるlog_levelについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-log_levelは、ログ出力レベルを設定します。
+``log_level`` command sets log level of Groonga.
 
 Syntax
 ------
@@ -32,27 +28,57 @@ Parameters
 
 ``level``
 
-  設定するログ出力レベルの値を以下のいずれかで指定します。
-
-     EMERG
-     ALERT
-     CRIT
-     error
-     warning
-     notice
-     info
-     debug
+  Specify log level with a character or string which means log level.
+
+  .. list-table::
+     :header-rows: 1
+
+     * - Value
+       - Alias
+     * - ``E``
+       - ``emerge`` or ``emergency``
+     * - ``A``
+       - ``alert``
+     * - ``C``
+       - ``crit`` or ``critical``
+     * - ``e``
+       - ``error``
+     * - ``w``
+       - ``warn`` or ``warning``
+     * - ``n``
+       - ``notice``
+     * - ``i``
+       - ``info``
+     * - ``d``
+       - ``debug``
+     * - ``-``
+       - ``dump``
+
+  Example::
+
+       emergency
+       alert
+       critical
+       error
+       warning
+       notice
+       info
+       debug
 
 Return value
 ------------
 
-::
+``log_level`` command returns whether log level configuration is succeeded or not::
+
+  [HEADER, SUCCEEDED_OR_NOT]
+
+``HEADER``
 
- [成功かどうかのフラグ]
+  See :doc:`/reference/command/output_format` about ``HEADER``.
 
-``成功かどうかのフラグ``
+``SUCCEEDED_OR_NOT``
 
-  エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
+  If command succeeded, it returns true, otherwise it returns false on error.
 
 See also
 --------