Kouhei Sutou
null+****@clear*****
Sun Aug 30 00:05:35 JST 2015
Kouhei Sutou 2015-08-30 00:05:35 +0900 (Sun, 30 Aug 2015) New Revision: 0dc1470ca3264f181954f5a3d9b61888d1ac69aa https://github.com/groonga/groonga/commit/0dc1470ca3264f181954f5a3d9b61888d1ac69aa Message: doc: describe about how to build as a developer GitHub: fix #357 Reported by Hiro Yoshioka. Thanks!!! Added files: doc/source/contribution/development/build.rst doc/source/contribution/development/build/unix_autotools.rst doc/source/contribution/development/build/unix_cmake.rst doc/source/contribution/development/build/windows_cmake.rst Modified files: README.md doc/locale/ja/LC_MESSAGES/contribution.po doc/source/contribution/development.rst doc/source/contribution/development/repository.rst doc/source/contribution/development/test.rst Modified: README.md (+6 -0) =================================================================== --- README.md 2015-08-29 23:32:14 +0900 (09e5764) +++ README.md 2015-08-30 00:05:35 +0900 (afaad94) @@ -6,6 +6,12 @@ Groonga is an open-source fulltext search engine and column store. See doc/source/ directory or http://groonga.org/docs/. +Here are shortcut links: + + * How to install: http://groonga.org/docs/install.html + * Tutorial: http://groonga.org/docs/tutorial.html + * How to build as a developer: http://groonga.org/docs/contribution/development/build.html + ## Bundled software ### mruby Modified: doc/locale/ja/LC_MESSAGES/contribution.po (+303 -2) =================================================================== --- doc/locale/ja/LC_MESSAGES/contribution.po 2015-08-29 23:32:14 +0900 (7b5a559) +++ doc/locale/ja/LC_MESSAGES/contribution.po 2015-08-30 00:05:35 +0900 (9c22c66) @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: 1.2.1\n" "Report-Msgid-Bugs-To: \n" -"PO-Revision-Date: 2014-12-24 23:39+0900\n" +"PO-Revision-Date: 2015-08-30 00:00+0900\n" "Last-Translator: Kouhei Sutou <kou �� clear-code.com>\n" "Language-Team: Japanese\n" "Language: ja\n" @@ -51,7 +51,302 @@ msgstr "開発者の立場で: 不具合報告や開発、ドキュメント" msgid "This section describes the details." msgstr "これらについてはこのセクションで説明します。" -msgid "Groonga開発者向け情報" +msgid "For Groonga developers" +msgstr "Groonga開発者向け情報" + +msgid "How to build Groonga at the repository" +msgstr "リポジトリーのGroongaをビルドする方法" + +msgid "" +"This document describes how to build Groonga at the repository for each " +"build system. You can choose GNU Autotools or CMake if you develop Groonga " +"on GNU/Linux or Unix (*BSD, Solaris, OS X and so on). You need to use CMake " +"if you develop on Windows." +msgstr "" +"このドキュメントではビルドシステム毎にリポジトリーにあるGroongaをビルドする方" +"法を説明します。GNU/LinuxまたはUnix（*BSDやSolaris、OS Xなど）でGroongaを開発" +"する場合はGNU AutotoolsかCMakeを選べます。Windowsで開発する場合はCMakeを使う" +"必要があります。" + +msgid "How to build Groonga at the repository by GNU Autotools" +msgstr "GNU Autotoolsを使ってリポジトリーのGroongaをビルドする方法" + +msgid "" +"This document describes how to build Groonga at the repository by GNU " +"Autotools." +msgstr "" +"このドキュメントはGNU Autotoolsを使ってリポジトリーのGroongaをビルドする方法" +"を説明します。" + +msgid "" +"You can't choose this way if you develop Groonga on Windows. If you want to " +"use Windows for developing Groonga, see :doc:`windows_cmake`." +msgstr "" +"WindowsでGroongaを開発する場合はこの方法を使えません。Groongaの開発にWindows" +"を使いたい場合は :doc:`windows_cmake` を参照してください。" + +msgid "TODO" +msgstr "" + +msgid "`Autoconf <http://www.gnu.org/software/autoconf/>`_" +msgstr "" + +msgid "`Automake <http://www.gnu.org/software/automake/>`_" +msgstr "" + +msgid "`GNU Libtool <http://www.gnu.org/software/libtool/>`_" +msgstr "" + +msgid "`Ruby <https://www.ruby-lang.org/>`_" +msgstr "" + +msgid "`Git <https://git-scm.com/>`_" +msgstr "" + +msgid "`Cutter <http://cutter.sourceforge.net/>`_" +msgstr "" + +msgid "..." +msgstr "" + +msgid "Checkout Groonga from the repository" +msgstr "リポジトリーからGroongaをチェックアウト" + +msgid "" +"Users use released source archive. But developers must build Groonga at the " +"repository. Because source code in the repository is the latest." +msgstr "" +"ユーザーはリリースされたソースアーカイブを使います。しかし、開発者はリポジト" +"リーからGroongaをビルドするべきです。なぜなら、リポジトリーにあるソースコード" +"が最新のソースコードだからです。" + +msgid "" +"The Groonga repository is hosted on `GitHub <https://github.com/groonga/" +"groonga>`_. Checkout the latest source code from the repository::" +msgstr "" +"Groongaのリポジトリーは `GitHub <https://github.com/groonga/groonga>`_ にあり" +"ます。リポジトリーから最新のソースコードをチェックアウトします::" + +msgid "Create ``configure``" +msgstr "``configure`` を作る" + +msgid "" +"You need to create ``configure``. ``configure`` is included in source " +"archive but not included in the repository." +msgstr "" +"``configure`` を作る必要があります。 ``configure`` はソースアーカイブには含ま" +"れていますが、リポジトリーには含まれていません。" + +msgid "" +"``configure`` is a build tool that detects your system and generates build " +"configurations for your environment." +msgstr "" +"``configure`` はあなたのシステムを検出してあなたの環境用のビルドパラメーター" +"を生成するビルドツールです。" + +msgid "Run ``autogen.sh`` to create ``configure``::" +msgstr "``configure`` を作るために ``autogen.sh`` を実行します::" + +msgid "Run ``configure``" +msgstr "``configure`` を実行" + +msgid "" +"You can custom your build configuration by passing options to ``configure``." +msgstr "" +"``configure`` にオプションを渡してビルドパラメーターをカスタマイズできます。" + +msgid "Here are recommended ``configure`` options for developers::" +msgstr "開発者向けのオススメの ``configure`` オプションは次の通りです::" + +msgid "Here are descriptions of these options:" +msgstr "それぞれのオプションの説明です。" + +msgid "" +"It specifies that you install your Groonga into temporary directory. You can " +"do \"clean install\" by removing ``/tmp/local`` directory. It'll be useful " +"for debugging install." +msgstr "" +"あなたのGroongaを一時ディレクトリーにインストールように指定しています。 ``/" +"tmp/local`` ディレクトリーを削除することで「クリーンインストール」を試すこと" +"ができます。インストール処理をデバッグするときに便利です。" + +msgid "``--prefix=/tmp/local``" +msgstr "" + +msgid "" +"It enables debug options for C/C++ compiler. It's useful for debugging on " +"debugger such as GDB and LLDB." +msgstr "" +"C/C++コンパイラーのデバッグオプションを有効にします。GDBやLLDBなどのデバッ" +"ガーでデバッグするときに便利です。" + +msgid "``--enable-debug``" +msgstr "" + +msgid "" +"It enables mruby support. The feature isn't enabled by default but " +"developers should enable the feature." +msgstr "" +"mrubyサポートを有効にします。この機能はデフォルトで無効になっていますが、開発" +"者はこの機能を有効にするべきです。" + +msgid "``--eanble-mruby``" +msgstr "" + +msgid "It's needed for ``--enable-mruby`` and running functional tests." +msgstr "``--enable-mruby`` オプションと機能テストの実行に必要です。" + +msgid "``--with-ruby``" +msgstr "" + +msgid "Run ``make``" +msgstr "``make`` を実行" + +msgid "Now, you can build Groonga." +msgstr "これでGroongaをビルドできるようになりました。" + +msgid "Here is a recommended ``make`` command line for developers::" +msgstr "開発者向けのオススメの ``make`` のコマンドラインです::" + +msgid "" +"``-j8`` decreases build time. It enables parallel build. If you have 8 or " +"more CPU cores, you can increase ``8`` to decreases more build time." +msgstr "" +"``-j8`` はビルド時間を短縮します。並列ビルドが有効になっているためです。も" +"し、CPUコアが8よりもたくさんあるのであれば、 ``8`` をもっと増やすとさらにビル" +"ドタイムを短縮できるでしょう。" + +msgid "" +"You can just see only warning and error messages by ``> /dev/null``. " +"Developers shouldn't add new warnings and errors in new commit." +msgstr "" +"``> /dev/null`` をつけることで警告メッセージとエラーメッセージだけが見えるよ" +"うになります。開発者は新しいコミットで警告メッセージもエラーメッセージも増や" +"すべきではありません。" + +msgid "See also" +msgstr "参考" + +msgid ":doc:`/contribution/development/test.rst`" +msgstr "" + +msgid "How to build Groonga at the repository by CMake on GNU/Linux or Unix" +msgstr "" +"GNU/LinuxまたはUnix上でCMakeを使ってリポジトリーのGroongaをビルドする方法" + +msgid "" +"This document describes how to build Groonga at the repository by CMake on " +"GNU/Linux or Unix." +msgstr "" +"このドキュメントではGNU/LinuxまたはUnix上でCMakeを使ってリポジトリーのGroonga" +"をビルドする方法を説明します。" + +msgid "Unix is *BSD, Solaris, OS X and so on." +msgstr "Unixとは*BSDやSolaris、OS Xなどのことです。" + +msgid "" +"If you want to use Windows for developing Groonga, see :doc:`windows_cmake`." +msgstr "" +"Groongaの開発にWindowsを使いたい場合は :doc:`windows_cmake` を参照してくださ" +"い。" + +msgid "" +"You can't choose this way if you want to release Groonga. Groonga release " +"system is only supported by GNU Autotools build. See :doc:`unix_autotools` " +"about GNU Autotools build." +msgstr "" + +msgid "`CMake <http://www.cmake.org/>`_" +msgstr "" + +msgid "Run ``cmake``" +msgstr "" + +msgid "You need to create ``Makefile`` for your environment." +msgstr "" + +msgid "" +"You can custom your build configuration by passing options to ``cmake``." +msgstr "" + +msgid "Here are recommended ``cmake`` options for developers::" +msgstr "" + +msgid "``-DCMAKE_INSTALL_PREFIX=/tmp/local``" +msgstr "" + +msgid "``-DGRN_WITH_DEBUG=on``" +msgstr "" + +msgid "``-DGRN_WITH_MRUBY=on``" +msgstr "" + +#, fuzzy +msgid "How to build Groonga at the repository by CMake on Windows" +msgstr "Groongaリポジトリのcloneの仕方" + +msgid "" +"This document describes how to build Groonga at the repository by CMake on " +"Windows." +msgstr "" + +msgid "" +"If you want to use GNU/Linux or Unix for developing Groonga, see :doc:" +"`unix_cmake`." +msgstr "" + +msgid "" +"`Microsoft Visual Studio Express 2013 for Windows Desktop <https://www." +"visualstudio.com/downloads/#d-2013-express>`_" +msgstr "" + +msgid "" +"`RubyInstaller for Windows <http://rubyinstaller.org/>`_ is recommended." +msgstr "" + +msgid "" +"`Git <https://git-scm.com/>`_: There are some Git clients for Windows. For " +"example:" +msgstr "" + +msgid "`The official Git package <https://git-scm.com/download/win>`_" +msgstr "" + +msgid "`TortoiseGit <https://tortoisegit.org/>`_" +msgstr "" + +msgid "`Git for Windows <https://git-for-windows.github.io/>`_" +msgstr "" + +msgid "`GitHub Desktop <https://desktop.github.com/>`_" +msgstr "" + +msgid "You must to pass ``-G`` option. Here are available ``-G`` value:" +msgstr "" + +msgid "``\"Visual Studio 12 2013\"``: For 32bit build." +msgstr "" + +msgid "``\"Visual Studio 12 2013 Win64\"``: For 64bit build." +msgstr "" + +msgid "``-G \"Visual Studio 12 2013 Win64\"``" +msgstr "" + +msgid "``-DCMAKE_INSTALL_PREFIX=C:\\Groonga``" +msgstr "" + +msgid "" +"It specifies that you install your Groonga into ``C:\\\\Groonga`` folder." +msgstr "" + +msgid "Build Groonga" +msgstr "" + +msgid "You can use Visual Studio or ``cmake --build``." +msgstr "" + +msgid "Here is a command line to build Groonga by ``cmake --build``::" msgstr "" msgid "Groonga 通信アーキテクチャ" @@ -1386,6 +1681,12 @@ msgstr "" msgid "テスト方法" msgstr "" +msgid "TODO: Write in English." +msgstr "" + +msgid "TODO: Write about ``test/command/run-test.sh``." +msgstr "" + msgid "テスト環境の構築" msgstr "" Modified: doc/source/contribution/development.rst (+3 -2) =================================================================== --- doc/source/contribution/development.rst 2015-08-29 23:32:14 +0900 (5e3aa1e) +++ doc/source/contribution/development.rst 2015-08-30 00:05:35 +0900 (edbaeaa) @@ -2,12 +2,13 @@ .. highlightlang:: none -Groonga開発者向け情報 -===================== +For Groonga developers +====================== .. toctree:: :maxdepth: 1 :glob: development/repository + development/build development/* Added: doc/source/contribution/development/build.rst (+19 -0) 100644 =================================================================== --- /dev/null +++ doc/source/contribution/development/build.rst 2015-08-30 00:05:35 +0900 (6f0d138) @@ -0,0 +1,19 @@ +.. -*- rst -*- + +.. highlightlang:: none + +How to build Groonga at the repository +====================================== + +This document describes how to build Groonga at the repository for +each build system. You can choose GNU Autotools or CMake if you +develop Groonga on GNU/Linux or Unix (*BSD, Solaris, OS X and so +on). You need to use CMake if you develop on Windows. + +.. toctree:: + :maxdepth: 1 + :glob: + + build/unix_autotools + build/unix_cmake + build/windows_cmake Added: doc/source/contribution/development/build/unix_autotools.rst (+101 -0) 100644 =================================================================== --- /dev/null +++ doc/source/contribution/development/build/unix_autotools.rst 2015-08-30 00:05:35 +0900 (a03449b) @@ -0,0 +1,101 @@ +.. -*- rst -*- + +.. highlightlang:: none + +How to build Groonga at the repository by GNU Autotools +======================================================= + +This document describes how to build Groonga at the repository by GNU +Autotools. + +You can't choose this way if you develop Groonga on Windows. If you +want to use Windows for developing Groonga, see :doc:`windows_cmake`. + +Install depended software +------------------------- + +TODO + + * `Autoconf <http://www.gnu.org/software/autoconf/>`_ + * `Automake <http://www.gnu.org/software/automake/>`_ + * `GNU Libtool <http://www.gnu.org/software/libtool/>`_ + * `Ruby <https://www.ruby-lang.org/>`_ + * `Git <https://git-scm.com/>`_ + * `Cutter <http://cutter.sourceforge.net/>`_ + * ... + +Checkout Groonga from the repository +------------------------------------ + +Users use released source archive. But developers must build Groonga +at the repository. Because source code in the repository is the +latest. + +The Groonga repository is hosted on `GitHub +<https://github.com/groonga/groonga>`_. Checkout the latest source +code from the repository:: + + % git clone --recursive git �� github.com:groonga/groonga.git + +Create ``configure`` +-------------------- + +You need to create ``configure``. ``configure`` is included in source +archive but not included in the repository. + +``configure`` is a build tool that detects your system and generates +build configurations for your environment. + +Run ``autogen.sh`` to create ``configure``:: + + % ./autogen.sh + +Run ``configure`` +----------------- + +You can custom your build configuration by passing options to +``configure``. + +Here are recommended ``configure`` options for developers:: + + % ./configure --prefix=/tmp/local --enable-debug --enable-mruby --with-ruby + +Here are descriptions of these options: + +``--prefix=/tmp/local`` + It specifies that you install your Groonga into temporary + directory. You can do "clean install" by removing + ``/tmp/local`` directory. It'll be useful for debugging install. + +``--enable-debug`` + It enables debug options for C/C++ compiler. It's useful for + debugging on debugger such as GDB and LLDB. + +``--eanble-mruby`` + It enables mruby support. The feature isn't enabled by default + but developers should enable the feature. + +``--with-ruby`` + It's needed for ``--enable-mruby`` and running functional tests. + +Run ``make`` +------------ + +Now, you can build Groonga. + +Here is a recommended ``make`` command line for developers:: + + % make -j8 > /dev/null + +``-j8`` decreases build time. It enables parallel build. If you have 8 +or more CPU cores, you can increase ``8`` to decreases more build +time. + +You can just see only warning and error messages by ``> +/dev/null``. Developers shouldn't add new warnings and errors in new +commit. + +See also +-------- + + * :doc:`/contribution/development/test.rst` Added: doc/source/contribution/development/build/unix_cmake.rst (+94 -0) 100644 =================================================================== --- /dev/null +++ doc/source/contribution/development/build/unix_cmake.rst 2015-08-30 00:05:35 +0900 (c2c5fcb) @@ -0,0 +1,94 @@ +.. -*- rst -*- + +.. highlightlang:: none + +How to build Groonga at the repository by CMake on GNU/Linux or Unix +==================================================================== + +This document describes how to build Groonga at the repository by +CMake on GNU/Linux or Unix. + +Unix is *BSD, Solaris, OS X and so on. + +If you want to use Windows for developing Groonga, see +:doc:`windows_cmake`. + +You can't choose this way if you want to release Groonga. Groonga +release system is only supported by GNU Autotools build. See +:doc:`unix_autotools` about GNU Autotools build. + +Install depended software +------------------------- + +TODO + + * `CMake <http://www.cmake.org/>`_ + * `Ruby <https://www.ruby-lang.org/>`_ + * `Git <https://git-scm.com/>`_ + * `Cutter <http://cutter.sourceforge.net/>`_ + * ... + +Checkout Groonga from the repository +------------------------------------ + +Users use released source archive. But developers must build Groonga +at the repository. Because source code in the repository is the +latest. + +The Groonga repository is hosted on `GitHub +<https://github.com/groonga/groonga>`_. Checkout the latest source +code from the repository:: + + % git clone --recursive git �� github.com:groonga/groonga.git + +Run ``cmake`` +------------- + +You need to create ``Makefile`` for your environment. + +You can custom your build configuration by passing options to +``cmake``. + +Here are recommended ``cmake`` options for developers:: + + % cmake . -DCMAKE_INSTALL_PREFIX=/tmp/local -DGRN_WITH_DEBUG=on -DGRN_WITH_MRUBY=on + +Here are descriptions of these options: + +``-DCMAKE_INSTALL_PREFIX=/tmp/local`` + + It specifies that you install your Groonga into temporary + directory. You can do "clean install" by removing + ``/tmp/local`` directory. It'll be useful for debugging install. + +``-DGRN_WITH_DEBUG=on`` + + It enables debug options for C/C++ compiler. It's useful for + debugging on debugger such as GDB and LLDB. + +``-DGRN_WITH_MRUBY=on`` + + It enables mruby support. The feature isn't enabled by default + but developers should enable the feature. + +Run ``make`` +------------ + +Now, you can build Groonga. + +Here is a recommended ``make`` command line for developers:: + + % make -j8 > /dev/null + +``-j8`` decreases build time. It enables parallel build. If you have 8 +or more CPU cores, you can increase ``8`` to decreases more build +time. + +You can just see only warning and error messages by ``> +/dev/null``. Developers shouldn't add new warnings and errors in new +commit. + +See also +-------- + + * :doc:`/contribution/development/test.rst` Added: doc/source/contribution/development/build/windows_cmake.rst (+93 -0) 100644 =================================================================== --- /dev/null +++ doc/source/contribution/development/build/windows_cmake.rst 2015-08-30 00:05:35 +0900 (8b4ab27) @@ -0,0 +1,93 @@ +.. -*- rst -*- + +.. highlightlang:: none + +How to build Groonga at the repository by CMake on Windows +========================================================== + +This document describes how to build Groonga at the repository by +CMake on Windows. + +If you want to use GNU/Linux or Unix for developing Groonga, see +:doc:`unix_cmake`. + +Unix is *BSD, Solaris, OS X and so on. + +Install depended software +------------------------- + + * `Microsoft Visual Studio Express 2013 for Windows Desktop + <https://www.visualstudio.com/downloads/#d-2013-express>`_ + * `CMake <http://www.cmake.org/>`_ + * `Ruby <https://www.ruby-lang.org/>`_ + + * `RubyInstaller for Windows <http://rubyinstaller.org/>`_ is + recommended. + + * `Git <https://git-scm.com/>`_: There are some Git clients for + Windows. For example: + + * `The official Git package <https://git-scm.com/download/win>`_ + * `TortoiseGit <https://tortoisegit.org/>`_ + * `Git for Windows <https://git-for-windows.github.io/>`_ + * `GitHub Desktop <https://desktop.github.com/>`_ + +Checkout Groonga from the repository +------------------------------------ + +Users use released source archive. But developers must build Groonga +at the repository. Because source code in the repository is the +latest. + +The Groonga repository is hosted on `GitHub +<https://github.com/groonga/groonga>`_. Checkout the latest source +code from the repository:: + + > git clone --recursive git �� github.com:groonga/groonga.git + +Run ``cmake`` +------------- + +You need to create ``Makefile`` for your environment. + +You can custom your build configuration by passing options to +``cmake``. + +You must to pass ``-G`` option. Here are available ``-G`` value: + + * ``"Visual Studio 12 2013"``: For 32bit build. + * ``"Visual Studio 12 2013 Win64"``: For 64bit build. + +Here are recommended ``cmake`` options for developers:: + + > cmake . -G "Visual Studio 12 2013 Win64" -DCMAKE_INSTALL_PREFIX=C:\Groonga -DGRN_WITH_MRUBY=on + +Here are descriptions of these options: + +``-G "Visual Studio 12 2013 Win64"`` + +``-DCMAKE_INSTALL_PREFIX=C:\Groonga`` + + It specifies that you install your Groonga into ``C:\\Groonga`` + folder. + +``-DGRN_WITH_MRUBY=on`` + + It enables mruby support. The feature isn't enabled by default + but developers should enable the feature. + +Build Groonga +------------- + +Now, you can build Groonga. + +You can use Visual Studio or ``cmake --build``. + +Here is a command line to build Groonga by ``cmake --build``:: + + > cmake --build . --config Debug + +See also +-------- + + * :doc:`/contribution/development/test.rst` Modified: doc/source/contribution/development/repository.rst (+7 -3) =================================================================== --- doc/source/contribution/development/repository.rst 2015-08-29 23:32:14 +0900 (a3ecd11) +++ doc/source/contribution/development/repository.rst 2015-08-30 00:05:35 +0900 (99284ab) @@ -5,8 +5,12 @@ 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:: +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 git://github.com/groonga/groonga.git + % 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). +There is `the list of related projects of Groonga +<https://github.com/groonga>`_ (grntest, fluent-plugin-groonga and so +on). Modified: doc/source/contribution/development/test.rst (+4 -0) =================================================================== --- doc/source/contribution/development/test.rst 2015-08-29 23:32:14 +0900 (b261953) +++ doc/source/contribution/development/test.rst 2015-08-30 00:05:35 +0900 (50dde5a) @@ -5,6 +5,10 @@ テスト方法 =========== +TODO: Write in English. + +TODO: Write about ``test/command/run-test.sh``. + テスト環境の構築 ---------------- -------------- next part -------------- HTML����������������������������...下載
