RubyGems - rroonga - Versions diffs - 7.0.2-x64-mingw32 → 7.1.1-x64-mingw32 - Mend

rroonga 7.0.2-x64-mingw32 → 7.1.1-x64-mingw32

Files changed (1237) hide show

data/vendor/local/share/doc/groonga/en/html/_sources/contribution/development/repository.txt DELETED Viewed

@@ -1,16 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-Repository
-==========
-There is `the repository of Groonga on GitHub
-<https://github.com/groonga/groonga>`_. If you want to check-out
-Groonga, type the below command::
-  % git clone --recursive https://github.com/groonga/groonga.git
-There is `the list of related projects of Groonga
-<https://github.com/groonga>`_ (grntest, fluent-plugin-groonga and so
-on).

data/vendor/local/share/doc/groonga/en/html/_sources/contribution/development/test.txt DELETED Viewed

@@ -1,120 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-テスト方法
-===========
-TODO: Write in English.
-TODO: Write about ``test/command/run-test.sh``.
-テスト環境の構築
-----------------
-Cutterのインストール
-^^^^^^^^^^^^^^^^^^^^
-Groongaは、テストのフレームワークとして Cutter_ を用いています。
-Cutterのインストール方法は プラットフォーム毎のCutterのインストール方法_ をご覧下さい。
-.. _Cutter: http://cutter.sourceforge.net/
-.. _プラットフォーム毎のCutterのインストール方法: http://cutter.sourceforge.net/reference/ja/install.html
-lcovのインストール
-^^^^^^^^^^^^^^^^^^
-カバレッジ情報を計測するためには、lcov 1.6以上が必要です。DebianやUbuntuでは以下のようにしてインストールできます。::
- % sudo aptitude install -y lcov
-clangのインストール
-^^^^^^^^^^^^^^^^^^^
-ソースコードの静的解析を行うためには、clang(scan-build)をインストールする必要があります。DebianやUbuntuでは以下のようにしてインストールできます。::
- % sudo aptitude install -y clang
-libmemcachedのインストール
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-memcachedのバイナリプロトコルのテストを動作させるためには、libmemcachedの導入が必要です。squeeze以降のDebianやKarmic以降のUubntuでは以下の用にしてインストールできます。::
- % sudo aptitude install -y libmemcached-dev
-テストの動作
-------------
-Groongaのトップディレクトリで、以下のコマンドを実行します。::
- make check
-カバレッジ情報
---------------
-Groongaのトップディレクトリで、以下のコマンドを実行します。::
- make coverage
-すると、coverageディレクトリ以下に、カバレッジ情報が入ったhtmlが出力されます。
-カバレッジには、Lines/Functions/Branchesの3つの対象があります。それぞれ、行／関数／分岐に対応します。Functionsがもっとも重要な対象です。すべての関数がテストされるようになっていることを心がけてください。
-テストがカバーしていない部分の編集は慎重に行ってください。また、テストがカバーしている部分を増やすことも重要です。
-様々なテスト
-------------
-テストは、test/unitディレクトリにおいて、./run-test.shを実行することによっても行えます。run-test.shはいくつかのオプションをとります。詳細は、./run-test.sh --helpを実行しヘルプをご覧ください。
-特定のテスト関数のみテストする
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-特定のテスト関数(Cutterではテストと呼ぶ)のみをテストすることができます。
-実行例::
- % ./run-test.sh -n test_text_otoj
-特定のテストファイルのみテストする
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-特定のテストファイル(Cutterではテストケースと呼ぶ)のみテストすることができます。
-実行例::
- % ./run-test.sh -t test_string
-不正メモリアクセス・メモリリーク検出
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-環境変数CUTTER_CHECK_LEAKをyesと設定すると、valgrindを用いて不正メモリアクセスやメモリリークを検出しつつ、テストを動作させることができます。
-run-test.shのみならず、make checkでも利用可能です。
-実行例::
- % CUTTER_CHECK_LEAK=yes make check
-デバッガ上でのテスト実行
-^^^^^^^^^^^^^^^^^^^^^^^^
-環境変数CUTTER_DEBUGをyesと設定すると、テストが実行できる環境が整ったgdbが実行されます。gdb上でrunを行うと、テストの実行が開始されます。
-run-test.shのみならず、make checkでも利用可能です。
-実行例::
- % CUTTER_DEBUG=yes make check
-静的解析
---------
-scan-buildを用いて、ソースコードの静的解析を行うことができます。scan_buildというディレクトリに解析結果のhtmlが出力されます。::
- % scan-build ./configure --prefix=/usr
- % make clean
- % scan-build -o ./scan_build make -j4
-configureは１度のみ実行する必要があります。

data/vendor/local/share/doc/groonga/en/html/_sources/contribution/documentation.txt DELETED Viewed

@@ -1,18 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-How to contribute in documentation topics
-=========================================
-We use Sphinx_ for documentation tool.
-.. _Sphinx: http://sphinx.pocoo.org/
-.. toctree::
-   :maxdepth: 1
-   :glob:
-   documentation/introduction
-   documentation/i18n
-   documentation/c-api

data/vendor/local/share/doc/groonga/en/html/_sources/contribution/documentation/c-api.txt DELETED Viewed

@@ -1,14 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-C API
-=====
-We still have C API documentation in include/groonga.h. But
-we want to move them into doc/source/c-api/\*.txt. We welcome
-to you help us by moving C API documentation.
-We will use `the C domain markup`_ of Sphinx.
-.. _the C domain markup: http://sphinx.pocoo.org/latest/domains.html#the-c-domain

data/vendor/local/share/doc/groonga/en/html/_sources/contribution/documentation/i18n.txt DELETED Viewed

@@ -1,200 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-I18N
-====
-We only had documentation in Japanese.  We start to support
-I18N documentation by gettext based `Sphinx I18N feature`_.
-We'll use English as base language and translate
-English into other languages such as Japanese. We'll put
-all documentations into doc/source/ and process them by
-Sphinx.
-.. _Sphinx I18N feature: http://sphinx.pocoo.org/latest/intl.html
-But we still use Japanese in doc/source/ for now. We need to
-translate Japanese documentation in doc/source/ into
-English. We welcome to you help us by translating
-documentation.
-Translation flow
-----------------
-After doc/source/\*.txt are updated, we can start translation.
-Here is a translation flow:
-1. Install Sphinx, if it is not installed.
-2. Clone Groonga repository.
-3. Update .po files.
-4. Edit .po files.
-5. Generate HTML files.
-6. Confirm HTML output.
-7. Repeat 2.-4. until you get good result.
-8. Send your works to us!
-Here are command lines to do the above flow. Following
-sections describes details.
-::
-  # Please fork https://github.com/groonga/groonga on GitHub
-  % git clone https://github.com/${YOUR_GITHUB_ACCOUNT}/groonga.git
-  % ./autogen.sh
-  % ./configure --enable-document
-  % cd doc/locale/${LANGUAGE}/LC_MESSAGES # ${LANGUAGE} is language code such as 'ja'.
-  % make update # *.po are updated
-  % editor *.po # translate *.po # you can use your favorite editor
-  % cd ..
-  % make html
-  % browser html/index.html # confirm translation
-  % git add LC_MESSAGES/*.po
-  % git commit
-  % git push
-How to install Sphinx
----------------------
-See the :doc:`introduction`.
-How to clone Groonga repository
--------------------------------
-First, please fork Groonga repository on GitHub. You
-just access https://github.com/groonga/groonga and press
-`Fork` button. Now you can clone your Groonga repository::
-  % git clone https://github.com/${YOUR_GITHUB_ACCOUNT}/groonga.git
-Then you need to configure your cloned repository::
-  % cd groonga
-  % ./autogen.sh
-  % ./configure --enable-document
-The above steps are just needed at the first setup.
-If you have troubles on the above steps, you can use source
-files available on http://packages.groonga.org/source/groonga/ .
-How to update .po files
------------------------
-You can update .po files by running `make update` on
-doc/locale/${LANGUAGE}/LC_MESSAGES. (Please substitute
-`${LANGUAGE}` with your language code such as 'ja'.)::
-  % cd doc/locale/ja/LC_MESSAGES
-  % make update
-How to edit .po
----------------
-There are some tools to edit .po files. .po files are just
-text. So you can use your favorite editor. Here is a
-specialized editor for .po file edit list.
-Emacs's po-mode_
-  It is bundled in gettext.
-Poedit_
-  It is a .po editor and works on many platform.
-gted
-  It is also a .po editor and is implemented as Eclipse plugin.
-.. _po-mode: http://www.gnu.org/s/hello/manual/gettext/PO-Mode.html
-.. _Poedit: http://www.poedit.net/
-.. _gted: http://www.gted.org/
-How to generate HTML files
---------------------------
-You can generate HTML files with updated .po files by
-running `make html` on doc/locale/${LANGUAGE}. (Please
-substitute `${LANGUAGE}` with your language code such as
-'ja'.)::
-  % cd doc/locale/ja/
-  % make html
-You can also generate HTML files for all languages by
-running `make html` on doc/locale::
-  % cd doc/locale
-  % make html
-.. note::
-   .mo files are updated automatically by `make html`. So
-   you don't care about .mo files.
-How to confirm HTML output
---------------------------
-HTML files are generated in
-doc/locale/${LANGUAGE}/html/. (Please substitute
-`${LANGUAGE}` with your language code such as 'ja'.) You can
-confirm HTML output by your favorite browser::
-  % firefox doc/locale/ja/html/index.html
-How to send your works
-----------------------
-We can receive your works via pull request on GitHub or
-E-mail attachment patch or .po files themselves.
-How to send pull request
-++++++++++++++++++++++++
-Here are command lines to send pull request::
-  % git add doc/locale/ja/LC_MESSAGES/*.po
-  % git commit
-  % git push
-Now you can send pull request on GitHub. You just access
-your repository page on GitHub and press `Pull Request`
-button.
-.. seealso:: `Help.GitHub - Sending pull requests <http://help.github.com/pull-requests/>`_.
-How to send patch
-+++++++++++++++++
-Here are command lines to create patch::
-  % git add doc/locale/ja/LC_MESSAGES/*.po
-  % git commit
-  % git format-patch origin/master
-You can find 000X-YYY.patch files in the current
-directory. Please send those files to us!
-.. seealso:: :doc:`/community` describes our contact information.
-How to send .po files
-+++++++++++++++++++++
-Please archive doc/locale/${LANGUAGE}/LC_MESSAGES/ (Please
-substitute `${LANGUAGE}` with your language code such as
-'ja'.) and send it to us! We extract and merge them to the
-Groonga repository.
-.. seealso:: :doc:`/community` describes our contact information.
-How to add new language
------------------------
-Here are command lines to add new translation language::
-  % cd doc/locale
-  % make add LOCALE=${LANGUAGE} # specify your language code such as 'de'.
-Please substitute `${LANGUAGE}` with your language code such
-as 'ja'.
-.. seealso:: `Codes for the Representation of Names of Languages <http://www.loc.gov/standards/iso639-2/php/English_list.php>`_.

data/vendor/local/share/doc/groonga/en/html/_sources/contribution/documentation/introduction.txt DELETED Viewed

@@ -1,81 +0,0 @@
-.. -*- rst -*-
-.. highlightlang:: none
-Introduction
-============
-This documentation describes about how to write, generate and manage
-Groonga documentation.
-Install depended software
--------------------------
-Groonga uses Sphinx_ as documentation tool.
-.. _Sphinx: http://sphinx.pocoo.org/
-Here are command lines to install Sphinx.
-Debian GNU/Linux, Ubuntu::
-  % sudo apt-get install -V -y python-sphinx
-CentOS, Fedora::
-  % sudo yum install -y python-pip
-  % sudo pip install sphinx
-OS X::
-  % brew install python
-  % brew install gettext
-  % export PATH=`brew --prefix gettext`/bin:$PATH
-  % pip install sphinx
-If the version of Python on your platform is too old, you'll need to
-install a newer version of Python 2.7 by your hand. For example, here
-are installation steps based on `pyenv
-<https://github.com/yyuu/pyenv>`_::
-  % pyenv install 2.7.11
-  % pyenv global 2.7.11
-  % pip install sphinx
-Run ``configure`` with ``--enable-document``
---------------------------------------------
-Groonga disables documentation generation by default. You need to
-enable it explicitly by adding ``--enable-document`` option to
-``configure``::
-  % ./configure --enable-document
-Now, your Groonga build is documentation ready.
-Generate HTML
--------------
-You can generate HTML by the following command::
-  % make -C doc html
-You can find generated HTML documentation at ``doc/locale/en/html/``.
-Update
-------
-You can find sources of documentation at ``doc/source/``. The sources
-should be written in English. See :doc:`i18n` about how to translate
-documentation.
-You can update the target file when you update the existing
-documentation file.
-You need to update file list after you add a new file, change file
-path and delete existing file. You can update file list by the
-following command::
-  % make -C doc update-files
-The command updates ``doc/files.am``.