null+****@clear*****
null+****@clear*****
2012年 6月 9日 (土) 22:18:19 JST
Kouhei Sutou 2012-06-09 22:18:19 +0900 (Sat, 09 Jun 2012)
New Revision: 5e4848833e7ff2ff2803e92bd5f901ddbf0b77b0
Log:
doc: add a document about Travis CI integration
Added files:
doc/source/development.txt
doc/source/development/travis-ci.txt
Modified files:
doc/files.am
doc/source/index.txt
Modified: doc/files.am (+12 -0)
===================================================================
--- doc/files.am 2012-06-09 22:36:12 +0900 (e517c8f)
+++ doc/files.am 2012-06-09 22:18:19 +0900 (d948b86)
@@ -42,6 +42,8 @@ absolute_source_files = \
$(top_srcdir)/doc/source/contribution/documentation/c-api.txt \
$(top_srcdir)/doc/source/contribution/documentation/i18n.txt \
$(top_srcdir)/doc/source/contribution/report.txt \
+ $(top_srcdir)/doc/source/development.txt \
+ $(top_srcdir)/doc/source/development/travis-ci.txt \
$(top_srcdir)/doc/source/example/commands/select/filter_equal.log \
$(top_srcdir)/doc/source/example/commands/select/filter_less_than.log \
$(top_srcdir)/doc/source/example/commands/select/limit_negative.log \
@@ -358,6 +360,8 @@ source_files_relative_from_doc_dir = \
source/contribution/documentation/c-api.txt \
source/contribution/documentation/i18n.txt \
source/contribution/report.txt \
+ source/development.txt \
+ source/development/travis-ci.txt \
source/example/commands/select/filter_equal.log \
source/example/commands/select/filter_less_than.log \
source/example/commands/select/limit_negative.log \
@@ -637,6 +641,7 @@ po_files = \
community.po \
conf.po \
contribution.po \
+ development.po \
executables.po \
expr.po \
functions.po \
@@ -665,6 +670,7 @@ po_files_relative_from_locale_dir = \
LC_MESSAGES/community.po \
LC_MESSAGES/conf.po \
LC_MESSAGES/contribution.po \
+ LC_MESSAGES/development.po \
LC_MESSAGES/executables.po \
LC_MESSAGES/expr.po \
LC_MESSAGES/functions.po \
@@ -693,6 +699,7 @@ mo_files = \
community.mo \
conf.mo \
contribution.mo \
+ development.mo \
executables.mo \
expr.mo \
functions.mo \
@@ -721,6 +728,7 @@ mo_files_relative_from_locale_dir = \
LC_MESSAGES/community.mo \
LC_MESSAGES/conf.mo \
LC_MESSAGES/contribution.mo \
+ LC_MESSAGES/development.mo \
LC_MESSAGES/executables.mo \
LC_MESSAGES/expr.mo \
LC_MESSAGES/functions.mo \
@@ -783,6 +791,8 @@ html_files_relative_from_locale_dir = \
html/_sources/contribution/documentation/c-api.txt \
html/_sources/contribution/documentation/i18n.txt \
html/_sources/contribution/report.txt \
+ html/_sources/development.txt \
+ html/_sources/development/travis-ci.txt \
html/_sources/executables.txt \
html/_sources/executables/grnslap.txt \
html/_sources/executables/grntest.txt \
@@ -909,6 +919,8 @@ html_files_relative_from_locale_dir = \
html/contribution/documentation/c-api.html \
html/contribution/documentation/i18n.html \
html/contribution/report.html \
+ html/development.html \
+ html/development/travis-ci.html \
html/executables.html \
html/executables/grnslap.html \
html/executables/grntest.html \
Added: doc/source/development.txt (+15 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/development.txt 2012-06-09 22:18:19 +0900 (ee366ff)
@@ -0,0 +1,15 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Development
+===========
+
+This section describes about developing with groonga. You may develop
+an application that uses groonga as its detabase, a library that uses
+libgroonga, language bindings of libgroonga and so on.
+
+.. toctree::
+ :maxdepth: 2
+
+ development/travis-ci
Added: doc/source/development/travis-ci.txt (+67 -0) 100644
===================================================================
--- /dev/null
+++ doc/source/development/travis-ci.txt 2012-06-09 22:18:19 +0900 (8ac0f33)
@@ -0,0 +1,67 @@
+.. -*- rst -*-
+
+.. highlightlang:: none
+
+Travis CI
+=========
+
+This section describes about using groonga on `Travis CI
+<http://travis-ci.org/>`_. Travis CI is a hosted continuous
+integration service for the open source community.
+
+You can use Travis CI for your open source software. This section only
+describes about groonga related configuration. See `Travis CI:
+Documentation <http://about.travis-ci.org/docs/>`_ about general
+Travis CI.
+
+Configuration
+-------------
+
+Travis CI is running on 32-bit Ubuntu 11.10 [#environment]_.
+You can use apt-line for Ubuntu 11.10 provided by groonga project to
+install groonga on Travis CI.
+
+You can custom build lifecycle by ``.travis.yml``
+[#build-configuration]_. You can use ``before_install`` hook or
+``install`` hook. You should use ``before_install`` if your software
+uses a language that is supported by Travis CI such as Ruby. You
+should use ``install`` otherwise.
+
+Add the following configuration to ``before_install``::
+
+ before_install:
+ - echo "deb http://packages.groonga.org/ubuntu/ $(lsb_release --short --codename) universe" | sudo tee /etc/apt/sources.list.d/groonga.list
+ - sudo apt-get update
+ - sudo apt-get -y --allow-unauthenticated install groonga-keyring
+ - sudo apt-get update
+ - sudo apt-get -y install libgroonga-dev
+
+If you need to use ``install`` hook instead of ``before_install``, you
+just substitute ``before_install:`` with ``install:``.
+
+With the above configuration, you can use groonga for your build.
+
+Examples
+--------
+
+Here are open source softwares that use groonga on Travis CI:
+
+ * `rroonga <http://groonga.rubyforge.org/#about-rroonga>`_ (Ruby bindings)
+
+ * `rroonga on Travis CI <http://travis-ci.org/#!/ranguba/rroonga>`_
+ * `.travis.yml for rroonga <https://github.com/ranguba/rroonga/blob/master/.travis.yml>`_
+
+ * `nroonga <http://nroonga.github.com/>`_ (node.js bindings)
+
+ * `nroonga on Travis CI <http://travis-ci.org/#!/nroonga/nroonga>`_
+ * `.travis.yml for nroong <https://github.com/nroonga/nroonga/blob/master/.travis.yml>`_
+
+.. rubric:: Footnotes
+
+.. [#environment] See `Travis CI: About Travis CI Environment
+ <http://about.travis-ci.org/docs/user/ci-environment/>`_ for more
+ details.
+.. [#build-configuration] See `Travis CI: Conifugration your Travis CI
+ build with .travis.yml
+ <http://about.travis-ci.org/docs/user/build-configuration/>`_ for
+ more details.
Modified: doc/source/index.txt (+1 -0)
===================================================================
--- doc/source/index.txt 2012-06-09 22:36:12 +0900 (513c6dd)
+++ doc/source/index.txt 2012-06-09 22:18:19 +0900 (2dc0d0e)
@@ -24,6 +24,7 @@ groonga documentation
spec
limitations
troubleshooting
+ development
contribution
* :ref:`genindex`