Merge lp:~aacid/unity8/coding_update into lp:unity8

Proposed by Albert Astals Cid on 2015-11-04
Status: Rejected
Rejected by: Albert Astals Cid on 2015-11-09
Proposed branch: lp:~aacid/unity8/coding_update
Merge into: lp:unity8
Diff against target: 138 lines (+3/-125)
1 file modified
CODING (+3/-125)
To merge this branch: bzr merge lp:~aacid/unity8/coding_update
Reviewer Review Type Date Requested Status
PS Jenkins bot continuous-integration Needs Fixing on 2015-11-05
Daniel d'Andrada (community) 2015-11-04 Disapprove on 2015-11-04
Review via email: mp+276662@code.launchpad.net

Commit Message

Point to the web

Let's not maintain two copies of the same thing that will get old and unsynced at different stages

Description of the Change

 * Are there any related MPs required for this MP to build/function as expected?
No

 * Did you perform an exploratory manual test run of your code change and any related functionality?
N/A

 * Did you make sure that your branch does not contain spurious tags?
Yes

 * If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
N/A

 * If you changed the UI, has there been a design review?
N/A

To post a comment you must log in.
Daniel d'Andrada (dandrader) wrote :

I prefer to keep those as close to the code as possible. They are more prone to getting outdated if kept separately.

I would rather do the other way around and build the web page from the this text file, like online documentation of libs.

review: Disapprove
Michael Zanetti (mzanetti) wrote :

I'm in favor of removing redundancy. Whether it is removing them here or generate the website out of it, I don't have a strong opinion. Generating the website out of it would be definitely more work tho.

PS Jenkins bot (ps-jenkins) wrote :

FAILED: Continuous integration, rev:2022
http://jenkins.qa.ubuntu.com/job/unity8-ci/6643/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/5014
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-xenial-touch/58/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/1355
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity8-qmluitest-xenial-amd64/58/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/1250
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/1251
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-xenial-amd64-ci/57
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-xenial-i386-ci/57
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/4025
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/5011
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/5011/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24903
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-xenial-armhf/58
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-xenial-armhf/58/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/6643/rebuild

review: Needs Fixing (continuous-integration)
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Continuous integration, rev:2022
http://jenkins.qa.ubuntu.com/job/unity8-ci/6646/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/5019/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-xenial-touch/61/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-vivid/1358
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity8-qmluitest-xenial-amd64/61/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-amd64-ci/1253
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-vivid-i386-ci/1254
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-xenial-amd64-ci/60
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-xenial-i386-ci/60
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/4030/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/5016
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/5016/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/24912
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-xenial-armhf/61
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-xenial-armhf/61/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/6646/rebuild

review: Needs Fixing (continuous-integration)
Albert Astals Cid (aacid) wrote :

Ok, it seems it didn't get enough consensus, someone else have to fix this duplication then.

Unmerged revisions

2022. By Albert Astals Cid on 2015-11-04

Point to the web

Let's not maintain two copies that will get old and unsynced at different stages

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'CODING'
2--- CODING 2015-06-23 07:51:27 +0000
3+++ CODING 2015-11-04 14:42:14 +0000
4@@ -1,131 +1,9 @@
5 Building Unity 8
6 ================
7
8-Only Ubuntu 14.04 (trusty) is supported as a developement environment.
9-
10-download source
11----------------
12-- create a parent folder to not pollute your setup. so that you can have different unity
13- branches there (trunk, WIP etc)
14-
15- $ mkdir ~/unity8
16-
17-- fetch Unity 8 source
18- $ sudo apt-get install bzr
19- $ bzr branch lp:unity8 ~/unity8/trunk
20- $ cd ~/unity8/trunk
21-
22-install dependencies
23---------------------
24-If its your first time, install build dependencies
25-
26-$ cd ~/unity8/trunk
27-$ ./build.sh --setup
28-
29- this will:
30- - install the required dependencies to build, as well as run on the desktop
31- - it should also install unity-scope-home and unity-lens-application which
32- are technically "recommends", not strict dependencies
33-
34-build Unity 8
35--------------
36-
37-$ cd ~/unity8/trunk
38-$ ./build.sh
39-
40-You may also rebuild with the -c for clean, which just deletes the build
41-directory.
42-
43-
44-Running Unity 8 on your desktop
45-===============================
46-
47-run the Unity 8 shell
48----------------------
49-$ cd ~/unity8/trunk
50-$ ./run.sh
51-
52-Options can be passed to test the lock screen
53-$ ./run.sh -p OR -k
54-
55--p is for pin lock, for which the default prompt answer is "1234"
56--k is for keylock passphrase, for which the default prompt answer is "password"
57-
58-Notes
59------
60-- to navigate, utilize the mouse left button as you would your finger
61-- to get the translations work, currently you have to do make install to
62- put the *.mo files into correct structure. We'll look for a better solution
63- later.
64- $ cd builddir; make install
65-- if you wish to populate contacts
66- $ sudo apt-get install gir1.2-ebook-1.2
67- $ manage-address-book.py create
68- this will:
69- - Create an EDS address book
70- - Populate the address book with sample data
71-
72-
73-Running Unity 8 on devices
74-==========================
75-- Ubuntu Touch builds are currently only available in 14.04 flavour
76-- supported hardware should match one of those listed here
77- https://wiki.ubuntu.com/Touch/Devices#Running_fine
78-- follow the Ubuntu Touch install instructions for your chosen device
79- https://wiki.ubuntu.com/Touch/Install
80-- make sure your device is connected to a network
81-- also make sure you have your SSH key in ~/.ssh/id_rsa.pub (or install one
82- on the device yourself)
83-
84-$ cd ~/unity/trunk
85-$ ./run_on_device.sh --setup
86- this will:
87- - install your public SSH key on the device
88- - install the needed dependencies
89-
90-$ ./run_on_device.sh
91- this will:
92- - rsync the code to the device
93- - build on the device
94- - replace the running shell
95-
96-Options can be passed to test the lock screen
97-$ ./run_on_device.sh -p OR -k
98-
99--p is for pin lock, for which the default prompt answer is "1234"
100--k is for keylock passphrase, for which the default prompt answer is "password"
101-
102-Notes
103------
104-- using adb over TCP has some advantages, Google will be of help here
105- - NOTE: this is not yet available for flipped images
106- - TL;DR: `adb tcpip 5555; adb connect $your_device_ip`
107- - you can persist the above via `adb shell setprop persist.adb.tcp.port 5555`
108- - it's unsafe - anyone can connect to your device
109- - with TCP the Nexus 10 doesn't drop the adb connection when locking
110- the screen
111-- exporting ANDROID_SERIAL=$your_device_serial or
112- ANDROID_SERIAL=$your_device_ip:5555 will make adb not complain about
113- multiple devices
114-- you can export TARGET_IP=$your_device_ip TARGET_SSH_PORT=22 for run_on_device.sh
115- to not use adb forwarding - useful if you use multiple devices
116-- using Ninja (package ninja-build - run_on_device.sh -s installs this now)
117- will improve build times (especially in the nothing-to-build case)
118-
119-
120-Coding guidelines
121-=================
122-The work-in-progress coding guidelines are available under:
123-https://launchpad.net/canonical-client-development-guidelines
124-
125-
126-Development Environment
127-=======================
128-QtCreator (available via the Software Center) is the best IDE to hack on
129-Unity 8.
130-
131-If using VIM, make sure you install some syntax highlighting for QML, like
132-https://github.com/peterhoeg/vim-qml
133+Please see
134+ https://unity.ubuntu.com/getinvolved/development/unity8/
135+for Building and running instructions
136
137 Running tests
138 =============

Subscribers

People subscribed via source and target branches