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

[Paul Sladen]

HACKING.txt: summary developer documentation to get people started
Includes link to: https://wiki.ubuntu.com/Unity2D#Coding
with details about proposing and merges any changes afterwards.

[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

[Albert Astals Cid (aacid)]

Seems Michał's comments were not addressed in this new MR

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)

[Paul Sladen (sladen)]

Michał: thanks for the suggestions, Albert to picking up that they'd acted upon yet.

[Albert Astals Cid (aacid)]

You need the
  killall -9 unity-2d-shell
twice also in your TL;DR: and step 4

Actually the double killall is only needed the first time. From then on it's only needed once

review: Needs Fixing

[Paul Sladen (sladen)]

Albert: right, so which /exact/ wording would you like. I'm happy to put in anything you want. Most people seem to use:

  killall unity-2d-shell
  killall unity-2d-shell

twice, whereas I use:

  killall -9 unity-2d-shell

once.

[Albert Astals Cid (aacid)]

  killall -9 unity-2d-shell
once doesn't work, unity-2d-shell will still be autorestarted if it is the first time you do call killall after login into unity2d

So in the TLDR i'd write
make -j4 && (killall unity-2d-shell; sleep 1; killall unity-2d-shell; sleep 1 && ./shell/app/unity-2d-shell &)

And then in the more detailed steps i'd write that you actually just need to killall unity-2d-shell twice the first time you execute the killall after a session login

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

939. By Paul Sladen on 2012-03-08

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

[Albert Astals Cid (aacid)]

Looks good :-)

review: Approve

=== added file 'HACKING.txt'
--- HACKING.txt	1970-01-01 00:00:00 +0000
+++ HACKING.txt	2012-03-08 12:12:21 +0000
@@ -0,0 +1,66 @@
+TL;DR:
+
+  sudo apt-get build-dep unity-2d
+  cmake .
+  make -j4 && (killall unity-2d-shell; sleep 1; killall 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 unity-2d-shell
+  killall unity-2d-shell
+  ./shell/app/unity-2d-shell &
+
+ To do iterative compile+test, you can use the command:
+
+  make -j4 && (killall unity-2d-shell; sleep 1 && ./shell/app/unity-2d-shell &)
+
+ (A double killall is only needed the first time after session
+ login.  This is to break the default automagic respawn cycle).
+
+ 5. Test again with non-compositing window-manager mode (eg. different assets
+  such as './shell/common/artwork/desktop_dash_background_no_transparency.sci'):
+  
+  killall unity-2d-shell
+  killall unity-2d-shell
+  metacity --replace --no-composite
+
+ 6. Restore compositing mode:
+
+  killall unity-2d-shell
+  killall unity-2d-shell
+  metacity --replace --composite
+
+  (The double killall is to defeat the auto-respawn)
+
+
+Debugging output:
+
+ a. From Qt C++ code:
+
+  qDebug() << "foobar=" << foobar;
+
+Finally:
+
+If you want to propose your changes for merging 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!