Merge lp:~sladen/unity-2d/unity-2d-coding-documentation into lp:unity-2d

[Paul Sladen]

HACKING.txt: summary developer documentation to get people started

[lp:~sladen/unity-2d/unity-2d-coding-documentation]

937. By Paul Sladen on 2012-02-24

Note how to merge back documented on http://wiki.ubuntu.com/Unity2D#Coding (thanks to Florian)

[Michał Sawicz (saviq)]

40 + gconftool-2 --set --type=bool /apps/metacity/general/compositing_manager false
41 + killall metacity
42 + killall -9 unity-2d

No need to change the gconf key, just go `metacity --replace --no-composite`. There is no "unity-2d" process, either. You also need to kill unity-2d-shell twice for the first time, 'cause gnome-session respawns it.

--8<--

47 + gconftool-2 --set --type=bool /apps/metacity/general/compositing_manager true
48 + killall metacity
49 + killall -9 unity-2d

Same as above - `metacity --replace --composite` and there's no "unity-2d" process.

--8<--

60 +If you want to proposed and merge your changes back into the main tree, see:

Maybe "If you want to propose your changes for merging back into the main tree, see:"?

review: Needs Fixing

[lp:~sladen/unity-2d/unity-2d-coding-documentation]

938. By Paul Sladen on 2012-03-06

Tweak HACKING.txt compositing and contributoring advice (thanks to Michał Sawicz)

939. By Paul Sladen on 2012-03-08

HACKING.txt: document more specifically the first-time double killall requirements (thanks to (Albert Astals Cid)

Unmerged revisions

=== added file 'HACKING.txt'
--- HACKING.txt	1970-01-01 00:00:00 +0000
+++ HACKING.txt	2012-02-24 15:17:30 +0000
@@ -0,0 +1,61 @@
+TL;DR:
+
+  sudo apt-get build-dep unity-2d
+  cmake .
+  make -j4 && (killall -9 unity-2d-shell ; sleep 1 && ./shell/app/unity-2d-shell &)
+
+
+Longer version
+
+To build trunk:
+
+ 1. Install build dependencies (on Ubuntu):
+
+  apt-get build-dep unity-2d
+
+ 2. Qt/QML preprocessing/preparation stage (the '.' is essential):
+
+  cmake .
+
+ 3. Compile (in parallel on four CPUs):
+
+  make -j4
+
+ 4. Test:
+
+  killall -9 unity-2d
+  ./shell/app/unity-2d-shell &
+
+ To do iterative compile+test, you can use the command:
+
+  make -j4 && (killall -9 unity-2d-shell ; sleep 1 && ./shell/app/unity-2d-shell &)
+
+ 5. Test again with non-compositing window-manager mode (eg. different assets
+  such as './shell/common/artwork/desktop_dash_background_no_transparency.sci'):
+  
+  gconftool-2 --set --type=bool /apps/metacity/general/compositing_manager false
+  killall metacity
+  killall -9 unity-2d
+  ./shell/app/unity-2d-shell &
+
+ 6. Restore compositing mode:
+
+  gconftool-2 --set --type=bool /apps/metacity/general/compositing_manager true
+  killall metacity
+  killall -9 unity-2d
+  ./shell/app/unity-2d-shell &
+
+Debugging output:
+
+ a. From Qt C++ code:
+
+  qDebug() << "foobar=" << foobar;
+
+Finally:
+
+If you want to proposed and merge your changes back into the main tree, see:
+
+  http://wiki.ubuntu.com/Unity2D#Coding
+
+
+Have fun!  -Paul Sladen, 2012-02-24 from advices of the DX team!