Merge lp:~kalikiana/u1db-qt/hackingDocs into lp:u1db-qt

[Cris Dywan]

Mention BUILD_DOC flag in HACKING file

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:109
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/35/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-precise-amd64-ci/35
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-saucy-amd64-ci/37
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-amd64-ci/15
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-armhf-ci/15

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/u1db-qt-ci/35/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:112
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/36/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-precise-amd64-ci/36
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-saucy-amd64-ci/38
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-amd64-ci/16
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-armhf-ci/16

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/u1db-qt-ci/36/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:114
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/39/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-precise-amd64-ci/39
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-saucy-amd64-ci/41
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-amd64-ci/19
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-armhf-ci/19

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/u1db-qt-ci/39/rebuild

review: Approve (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

28 +Build dependencies to have:
29 + ubuntu-sdk-libs-dev, dbus-test-runner, qtdeclarative5-test-plugin

Perhaps we could add a command here, sudo apt-get build-dep u1db-qt. This should automatically install all required dependencies.

The other sections such as retrieving source, building it, and testing by hand works as expected.

I haven't reviewed others such as Build Docs and Unit tests since I am not too familiar with them.

[lp:~kalikiana/u1db-qt/hackingDocs]

115. By Cris Dywan on 2014-03-10

Mention apt-get build-dep for installing dependencies

[Nekhelesh Ramananthan (nik90)]

yup that looks good.

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:115
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/44/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-precise-amd64-ci/44
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-saucy-amd64-ci/46
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-amd64-ci/24
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-armhf-ci/24

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/u1db-qt-ci/44/rebuild

review: Approve (continuous-integration)

=== modified file 'HACKING'
--- HACKING	2013-03-27 16:51:12 +0000
+++ HACKING	2014-03-10 11:15:59 +0000
@@ -1,21 +1,38 @@
 *** Building and installing ***
 
-cmake .; make
-sudo make install
-
-*** Test from the build folder ***
-
-qmlscene -I ./modules examples/u1db-qt-example-1.qml
-qmltestrunner -import ./modules
-make check
-
-*** Run reference test cases ***
-
-make
-env PYTHONPATH=/path/to/u1db ./tests/test-upstream.py
-
-*** Use U1DB Python API to check sqlite compatiblity ***
-
-python -c "import u1db;db=u1db.open('pDb',create=False);print(db.get_all_docs());print(db.list_indexes())"
-python -c "import u1db;db=u1db.open('pDb',create=True);db.create_index('by-phone', 'gents.phone');doc3 = db.create_doc({'gents': [ {'name': 'Mary', 'phone': '12345'}, {'name': 'Peter', 'phone': '54321'} ]})"
+Get the source:
+    bzr branch lp:u1db-qt
+
+Build dependencies to have:
+    ubuntu-sdk-libs-dev, dbus-test-runner, qtdeclarative5-test-plugin
+
+    All of these can also be installed with one command:
+    sudo apt-get build-dep u1db-qt
+
+Build it:
+    mkdir _build; cd _build; cmake ..
+    make
+    sudo make install
+
+Build docs:
+    make doc
+
+Unit tests:
+    make check
+
+Note: both docs and tests must pass for branches proposed for merging.
+
+*** Further debugging and testing ***
+
+By hand:
+    qmlscene -I ./modules examples/u1db-qt-example-1.qml
+    qmltestrunner -import ./modules
+
+Partial upstream test case support:
+    make
+    env PYTHONPATH=/path/to/u1db ./tests/test-upstream.py
+
+Use Python U1Db for testing:
+    python -c "import u1db;db=u1db.open('pDb',create=False);print(db.get_all_docs());print(db.list_indexes())"
+    python -c "import u1db;db=u1db.open('pDb',create=True);db.create_index('by-phone', 'gents.phone');doc3 = db.create_doc({'gents': [ {'name': 'Mary', 'phone': '12345'}, {'name': 'Peter', 'phone': '54321'} ]})"