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

Proposed by Cris Dywan
Status: Merged
Approved by: Cris Dywan
Approved revision: 115
Merged at revision: 127
Proposed branch: lp:~kalikiana/u1db-qt/hackingDocs
Merge into: lp:u1db-qt
Diff against target: 59 lines (+35/-18)
1 file modified
HACKING (+35/-18)
To merge this branch: bzr merge lp:~kalikiana/u1db-qt/hackingDocs
Reviewer Review Type Date Requested Status
PS Jenkins bot continuous-integration Approve
Nekhelesh Ramananthan (community) Approve
Benjamin Zeller Pending
Review via email: mp+205426@code.launchpad.net

Commit message

Mention BUILD_DOC flag in HACKING file

To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
Nekhelesh Ramananthan (nik90) wrote :

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 updated
115. By Cris Dywan

Mention apt-get build-dep for installing dependencies

Revision history for this message
Nekhelesh Ramananthan (nik90) wrote :

yup that looks good.

review: Approve
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'HACKING'
--- HACKING 2013-03-27 16:51:12 +0000
+++ HACKING 2014-03-10 11:15:59 +0000
@@ -1,21 +1,38 @@
1*** Building and installing ***1*** Building and installing ***
22
3cmake .; make3Get the source:
4sudo make install4 bzr branch lp:u1db-qt
55
6*** Test from the build folder ***6Build dependencies to have:
77 ubuntu-sdk-libs-dev, dbus-test-runner, qtdeclarative5-test-plugin
8qmlscene -I ./modules examples/u1db-qt-example-1.qml8
9qmltestrunner -import ./modules9 All of these can also be installed with one command:
10make check10 sudo apt-get build-dep u1db-qt
1111
12*** Run reference test cases ***12Build it:
1313 mkdir _build; cd _build; cmake ..
14make14 make
15env PYTHONPATH=/path/to/u1db ./tests/test-upstream.py15 sudo make install
1616
17*** Use U1DB Python API to check sqlite compatiblity ***17Build docs:
1818 make doc
19python -c "import u1db;db=u1db.open('pDb',create=False);print(db.get_all_docs());print(db.list_indexes())"19
20python -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'} ]})"20Unit tests:
21 make check
22
23Note: both docs and tests must pass for branches proposed for merging.
24
25*** Further debugging and testing ***
26
27By hand:
28 qmlscene -I ./modules examples/u1db-qt-example-1.qml
29 qmltestrunner -import ./modules
30
31Partial upstream test case support:
32 make
33 env PYTHONPATH=/path/to/u1db ./tests/test-upstream.py
34
35Use Python U1Db for testing:
36 python -c "import u1db;db=u1db.open('pDb',create=False);print(db.get_all_docs());print(db.list_indexes())"
37 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'} ]})"
2138

Subscribers

People subscribed via source and target branches

to all changes: