Merge lp:~kgunn72/unity/8_CODING_updates into lp:unity/8.0

[kevin gunn]

update to the CODING file

update to the CODING file

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:46
http://jenkins.qa.ubuntu.com/job/unity-8.0-ci/198/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-saucy/372
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-8.0-saucy-armhf-ci/196
        deb: http://jenkins.qa.ubuntu.com/job/unity-8.0-saucy-armhf-ci/196/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-8.0-saucy-i386-ci/197
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-saucy/192
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy/374
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-saucy/374/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-saucy/340

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-8.0-ci/198/rebuild

review: Approve (continuous-integration)

[Michał Sawicz (saviq)]

Guys, you need to agree on something here ;)

https://code.launchpad.net/~dandrader/unity/8_updateCODING/+merge/171404

[Daniel d'Andrada (dandrader)]

49 +Options can be passed to test the lock screen
50 +$ ./run -p OR -k
51 +
52 +-p is for pin lock, for which the default prompt answer is "1234"
53 +-k is for keylock passphrase, for which the default prompt answer is "password"

I think enumerating the options is the task of "./run --help". Would be good to inform the default passwords there.

CODING is meant for a new developer to get started. So, IMHO, it should be about the basic stuff only. I wasn't aware of those run options and default passwords myself. :-D

[kevin gunn (kgunn72)]

> 49 +Options can be passed to test the lock screen
> 50 +$ ./run -p OR -k
> 51 +
> 52 +-p is for pin lock, for which the default prompt answer is "1234"
> 53 +-k is for keylock passphrase, for which the default prompt answer is
> "password"
>
> I think enumerating the options is the task of "./run --help". Would be good
> to inform the default passwords there.
>
> CODING is meant for a new developer to get started. So, IMHO, it should be
> about the basic stuff only. I wasn't aware of those run options and default
> passwords myself. :-D

I'll go out on a limb and say most folks don't run --help, so think of this as nice advertisement about -p/-k....note i didn't put -f or -m. Remember we are also using this text on the wiki to promote playing around with unity8. And sorry, i didn't see your MP (doh) should we just merge yours in here ?

[Michał Sawicz (saviq)]

Superseded by https://code.launchpad.net/~kgunn72/unity8/CODING_updates/+merge/171845

review: Disapprove

Unmerged revisions

=== modified file 'CODING'
--- CODING	2013-06-13 11:32:52 +0000
+++ CODING	2013-06-25 23:25:33 +0000
@@ -3,7 +3,8 @@
 
 download source
 ---------------
-- the build requires some additional dependencies, so create the parent folder to not pollute your setup
+- the build requires some additional dependencies, so create the parent
+folder to not pollute your setup
   $ mkdir ~/unity
 
 - fetch Unity 8 source
@@ -16,19 +17,22 @@
 If its your first time, download & build deps
 $ ./build -s
   this will:
-  - add ppa:phablet-team/desktop-deps, ppa:canonical-qt5-edgers/qt5-proper, ppa:ubuntu-sdk-team
-  - build and install lp:libunity/phablet, lp:unity/phablet-mods, lp:hud/phablet locally
-  - install build dependencies
+  - add the following ppa's
+    - ppa:phablet-team/desktop-deps
+    - ppa:canonical-qt5-edgers/qt5-proper
+    - ppa:ubuntu-sdk-team
+  - install the required dependencies to build, as well as run on the desktop
+
+Note, once the ppa's are added a apt-get update will be run, if you have
+any failures associated with it, the build script will bail out of the setup
+and fail to install all the required dependencies.
 
 build Unity 8
 -------------
 $ ./build
 
-subsequent updates of the dependencies
---------------------------------------
-$ ./build_unity -u
-$ ./build_unity
-
+You may also rebuild with the -c for clean, which just deletes the build
+directory.
 
 Running Unity 8 on your desktop
 ===============================
@@ -38,6 +42,12 @@
 $ cd ~/unity/unity8
 $ ./run
 
+Options can be passed to test the lock screen
+$ ./run -p OR -k
+
+-p is for pin lock, for which the default prompt answer is "1234"
+-k is for keylock passphrase, for which the default prompt answer is "password"
+
 Notes
 -----
 - to navigate, utilize the mouse left button as you would your finger
@@ -49,10 +59,16 @@
 Running Unity 8 on devices
 ==========================
 - Ubuntu Touch builds are currently only available in 13.10 flavour
-- supported hardware should match one those listed here https://wiki.ubuntu.com/Touch/Devices#Running_fine
-- follow the Ubuntu Touch install instructions for your chosen device https://wiki.ubuntu.com/Touch/Install
+- supported hardware should match one those listed here
+https://wiki.ubuntu.com/Touch/Devices#Running_fine
+- follow the Ubuntu Touch install instructions for your chosen device
+https://wiki.ubuntu.com/Touch/Install
 - make sure your device is connected to a WiFi network
-- also make sure you have your SSH key in ~/.ssh/id_rsa.pub (or install one on the device yourself)
+- If you haven’t already or if you’ve just freshly flashed your device
+make sure you run phablet-network-setup which will allow package updates to
+the device
+- also make sure you have your SSH key in ~/.ssh/id_rsa.pub (or install one
+on the device yourself)
 
 $ cd ~/unity/unity8
 $ ./run_on_device -s
@@ -67,18 +83,27 @@
   - build on the device
   - replace the running shell
 
+Options can be passed to test the lock screen
+$ ./run_on_device -p OR -k
+
+-p is for pin lock, for which the default prompt answer is "1234"
+-k is for keylock passphrase, for which the default prompt answer is "password"
+
 Notes
 -----
 - using adb over TCP has some advantages, Google will be of help here
   - TL;DR: `adb tcpip 5555; adb connect $your_device_ip`
   - you can persist the above via `adb shell setprop persist.adb.tcp.port 5555`
   - it's unsafe - anyone can connect to your device
-  - with TCP the Nexus 10 doesn't drop the adb connection when locking the screen
-- exporting ANDROID_SERIAL=$your_device_serial or ANDROID_SERIAL=$your_device_ip:5555
-  will make adb not complain about multiple devices 
+  - with TCP the Nexus 10 doesn't drop the adb connection when locking
+  the screen
+- exporting ANDROID_SERIAL=$your_device_serial or
+ANDROID_SERIAL=$your_device_ip:5555
+  will make adb not complain about multiple devices
 - you can export TARGET_IP=$your_device_ip TARGET_SSH_PORT=22 for run_on_device
   to not use adb forwarding - useful if you use multiple devices
-- using Ninja (package ninja-build - run_on_device -s installs this now) will improve
+- using Ninja (package ninja-build - run_on_device -s installs this now)
+will improve
   build times (especially in the nothing-to-build case)
 
 
@@ -90,4 +115,6 @@
 
 Development Environment
 =======================
-QtCreator (available via the Software Center) is the best IDE to hack on Unity 8.
+QtCreator (available via the Software Center) is the best IDE to hack on
+Unity 8.
+