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

Proposed by Christian Dywan on 2014-02-07
Status: Merged
Approved by: Christian Dywan on 2014-03-10
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 on 2014-03-10
Nekhelesh Ramananthan (community) Approve on 2014-03-10
Benjamin Zeller 2014-02-07 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.
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 on 2014-03-10
115. By Christian Dywan on 2014-03-10

Mention apt-get build-dep for installing dependencies

Nekhelesh Ramananthan (nik90) wrote :

yup that looks good.

review: Approve

Preview Diff

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

Subscribers

People subscribed via source and target branches

to all changes: