Features/Optimize TreeViews - Revision history

Godiard at 14:51, 21 July 2015

2015-07-21T14:51:51Z

← Older revision		Revision as of 10:51, 21 July 2015
Line 1:		Line 1:
	<noinclude>		<noinclude>
	[[Category:~~Feature Page Incomplete]]~~		[[Category:FeatureLanded\|Optimize TreeViews]]
	~~[[Category:Feature~~\|Optimize TreeViews]]
	</noinclude>		</noinclude>

Godiard: /* Current status */

2014-11-17T12:17:16Z

Current status

← Older revision		Revision as of 08:17, 17 November 2014
Line 14:		Line 14:

	== Current status ==		== Current status ==
	* Targeted release: 0.~~102~~		* Targeted release: 0.104
	* Last updated: ~~Feb 24~~, 2014		* Last updated: Nov 17, 2014
	* Percentage of completion: 60%		* Percentage of completion: 90%

	== Detailed Description ==		== Detailed Description ==

Godiard: /* Comments and Discussion */

2014-11-17T11:39:55Z

Comments and Discussion

← Older revision		Revision as of 07:39, 17 November 2014
Line 101:		Line 101:
	== Comments and Discussion ==		== Comments and Discussion ==
	Your comments are very welcome. Please discuss through the mailing list.		Your comments are very welcome. Please discuss through the mailing list.

			The initial announcement in the mailing list is here [http://lists.sugarlabs.org/archive/sugar-devel/2014-February/047236.html]

Godiard: /* How To Test */

2014-11-17T11:37:47Z

How To Test

← Older revision		Revision as of 07:37, 17 November 2014
Line 72:		Line 72:

	== How To Test ==		== How To Test ==
	We did a test program that has a list (treeview) with many rows. Each row has a cellrenderer icon. The program automatically starts scrolling until the end of the list is reached. Then we can get profiling information using Python cProfile http://docs.python.org/2/library/profile.html . We ran the test like this inside a Sugar shell:

	python -m cProfile ~~test_treeview~~.py > profile.txt		To test the changes in the journal we used a python program to start the journal window from a terminal.
			You can download it here [http://dev.laptop.org/~gonzalo/start_journal.py]

			To use it do:

			python -m cProfile start_journal.py > profile.txt

			After run it in a Sugar terminal, the view jump to the Home, but in the frame you can see two journal icons.
			The second is the profiled version. In the toolbar have a Stop button.
			After stop, you can check the profile.txt file.

	== User Experience ==		== User Experience ==

Godiard: /* Detailed Description */

2014-11-17T11:28:58Z

Detailed Description

@@ Line 25: / Line 25: @@
 * Sugar CellRendererIcon has too much logic inside.  It should only handle how to render itself.
 * Sugar CellRendererIcon is connected to many signals.  Just detaching them while scrolling provides a performance boost.
@@ Line 30: / Line 32: @@
 * Sugar CellRendererIcon could benefit from caching values instead of calculating them on each render.
-We couldn't find what's wrong with the Journal.  We guess there is a DBus blocking call, but we could't confirm that.
+* There are a additional block in the Journal. That is not addressed by this feature, we guess there is a DBus blocking call,
 === GTK+ concepts ===
@@ Line 39: / Line 61: @@
 * GtkCellRenderer — An object for rendering a single cell https://developer.gnome.org/gtk3/stable/GtkCellRenderer
 == Benefit to Sugar ==

FGrose: sort in Category view

2014-02-25T02:24:54Z

sort in Category view

← Older revision		Revision as of 22:24, 24 February 2014
Line 1:		Line 1:
	<noinclude>		<noinclude>
	[[Category:Feature Page Incomplete]]		[[Category:Feature Page Incomplete]]
	[[Category:Feature\|.]]		[[Category:Feature\|Optimize TreeViews]]
	</noinclude>		</noinclude>

Manuq: Created page with " Category:Feature Page Incomplete . == Summary == Gonzalo Odiard and Manuel Quiñones did a hackaton to find out why the list..."

2014-02-24T22:49:13Z

Created page with "<noinclude> Category:Feature Page Incomplete . </noinclude> == Summary == Gonzalo Odiard and Manuel Quiñones did a hackaton to find out why the list..."

New page

<noinclude>
[[Category:Feature Page Incomplete]]
[[Category:Feature|.]]
</noinclude>

== Summary ==
Gonzalo Odiard and Manuel Quiñones did a hackaton to find out why the
lists that contain icons are so slow. The affected views in Sugar are
the Journal list and the activities list. This feature is about improving the TreeView performance.

== Owner ==
* Name: [[User:Manuq| Manuel Quiñones]]
* Name: [[User:Godiard| Gonzalo Odiard]]

== Current status ==
* Targeted release: 0.102
* Last updated: Feb 24, 2014
* Percentage of completion: 60%

== Detailed Description ==

=== Findings ===

* The source of the performance issues is Sugar CellRendererIcon, a treeview without it works ok. https://github.com/sugarlabs/sugar-toolkit-gtk3/blob/master/src/sugar3/graphics/icon.py#L781

* Sugar CellRendererIcon has too much logic inside. It should only handle how to render itself.

* Sugar CellRendererIcon is connected to many signals. Just detaching them while scrolling provides a performance boost.

* Sugar CellRendererIcon could benefit from caching values instead of calculating them on each render.

We couldn't find what's wrong with the Journal. We guess there is a DBus blocking call, but we could't confirm that.

=== GTK+ concepts ===

* GtkTreeView — A widget for displaying both trees and lists https://developer.gnome.org/gtk3/stable/GtkTreeView

* GtkTreeViewColumn — A visible column in a GtkTreeView widget https://developer.gnome.org/gtk3/stable/GtkTreeViewColumn.html

* GtkCellRenderer — An object for rendering a single cell https://developer.gnome.org/gtk3/stable/GtkCellRenderer

== Benefit to Sugar ==
Performance!

== Scope ==
Affects Shell and Toolkit.

==UI Design==
We should not regress treeviews. Pay special attention to Journal list and activities list.

== How To Test ==
We did a test program that has a list (treeview) with many rows. Each row has a cellrenderer icon. The program automatically starts scrolling until the end of the list is reached. Then we can get profiling information using Python cProfile http://docs.python.org/2/library/profile.html . We ran the test like this inside a Sugar shell:

python -m cProfile test_treeview.py > profile.txt

== User Experience ==
Users should notice a performance boost.

== Dependencies ==
No deps.

== Contingency Plan ==
These optimizations can come in small steps, so there is no need for a contingency plan.

== Documentation ==
To be written.

== Release Notes ==
To be written.

== Comments and Discussion ==
Your comments are very welcome. Please discuss through the mailing list.