Merge lp:~carifio/seahorse/seahorse-remove-broken-help-buttons into lp:ubuntu/precise/seahorse

[Mike Carifio]

This merge proposal mitigates the issue described in LP:#853137 by making
the help button in certain widgets invisible.

Note that I've chosen to leave the buttons intact but invisible. When
the right help content is authored, then I believe the button
should be exposed again. This change minimizes the amount of work to make
that better solution happen.

[lp:~carifio/seahorse/seahorse-remove-broken-help-buttons]

112. By Mike Carifio on 2012-10-11

Let the patch do the work.

[Mathieu Trudel-Lapierre (cyphermox)]

The execution of this fix looks good at first glance, but please follow the comment I've left on bug 853137 to apply for the SRU.

Otherwise, my only concern at this point would be that you should replace UNRELEASED with "precise-proposed" since this is a SRU, and please add DEP-3 tags [1] to your patch :)

[1] http://dep.debian.net/deps/dep3/

review: Needs Fixing

[lp:~carifio/seahorse/seahorse-remove-broken-help-buttons]

113. By Mike Carifio on 2012-10-17

Added metadata describing the patch consistent with Debian and
Ubuntu guidelines.

114. By Mike Carifio on 2012-10-18

UNRELEASED -> precise-proposed

[Mike Carifio (carifio)]

[IMPACT]

 * There are two help buttons on various dialogs that run
   yelp with non-existant pages.

 * This bug looks bad and mars the experience for end users.
   OEMs don't like that.

 * The fix removes the chance for error by making the help
   buttons invisible.

[TESTCASE]

 * seahorse > (Passsword and Keyss) > [tab] Passwords > Passwors:
   default> [right-click] Properties > "Passwords:default"
   > (dialog window "Passwords:default") > Keyring >
   Name:=default, Created:=(empty) > Help > (Help) > "PageNotFound": >
   The page 'gkr-keyring' was not found in the document 'ghelp:seahorse'.

[Regression Potential]

 * In the worst case scenario, setting the buttons invisible in the glade
   xml could be overridden by seahorse code. The help buttons would then be
   visible. The end user could reproduce the problem. This would mar
   the end user experience. But it wouldn't stop seahorse from doing
   its job.

[Mike Carifio (carifio)]

My checklist items:

1) Annotate the patch using the Debian and Ubuntu guidelines.

2) Change the series (UNRELEASED -> precise-proposed)

3) Document the SRU using the format summarized at
   http://wiki.ubuntu.com/StableReleaseUpdates#Procedure

Would you like me to request another review? Please advise at your
convenience. Thanks.

[Sebastien Bacher (seb128)]

Thanks Mike for your work, sorry I worked on that issue around the same time and uploaded those versions as SRU

Your solution would have been border line for a SRU since we try to not change the UI in stable upload, the hack I opted for is to just open the keyring help-page for those buttons:
http://bugzilla-attachments.gnome.org/attachment.cgi?id=226664

That should let the UI as it is but not lead to error pages.

Sorry that your work didn't land in Ubuntu there, I'm sure you will get luckier next time ;-)

Unmerged revisions

114. By Mike Carifio on 2012-10-18

UNRELEASED -> precise-proposed

113. By Mike Carifio on 2012-10-17

Added metadata describing the patch consistent with Debian and
Ubuntu guidelines.

112. By Mike Carifio on 2012-10-11

Let the patch do the work.

111. By Mike Carifio on 2012-10-11

Reformatted the changelog to be more consistent with debian
formats as I understand them:

* debian/patches/40_remove_broken_help_buttons.patch:
  - gkr/seahorse-gkr-item-properties.xml: Made widget helpbutton1 invisible
    This disables the help button, which has no
    associated content and leads to a yelp error (LP: #853137).
  - gkr/seahorse-gkr-keyring.xml: Made widget helpbutton1 invisible
    This disables the help button, which has no
    associated content and leads to a yelp error.
  - Note: I've chosen to leave the widget intact but invisible. When
    the right help content is authored, then I believe this widget
    should be exposed again.

110. By Mike Carifio on 2012-10-11

Note: I've chosen to leave the widget intact but invisible. When
the right help content is authored, then I believe this widget
should be exposed again.

109. By Mike Carifio on 2012-10-11

* debian/patches/40_remove_broken_help_buttons.patch:
  * gkr/seahorse-gkr-item-properties.xml: Made widget helpbutton1 invisible
    This disables the help button, which has no
    associated content and leads to a yelp error (LP: #853137).
  * gkr/seahorse-gkr-keyring.xml: Made widget helpbutton1 invisible
    This disables the help button, which has no
    associated content and leads to a yelp error.

=== modified file '.pc/applied-patches'
--- .pc/applied-patches	2012-04-11 16:06:48 +0000
+++ .pc/applied-patches	2012-10-18 13:59:24 +0000
@@ -3,3 +3,4 @@
 03_broken_search.patch
 08_force_ssh.patch
 30_preferences_menu.patch
+40_remove_broken_help_buttons.patch

=== modified file 'debian/changelog'
--- debian/changelog	2012-04-11 16:06:48 +0000
+++ debian/changelog	2012-10-18 13:59:24 +0000
@@ -1,3 +1,18 @@
+seahorse (3.2.2-0ubuntu3) precise-proposed; urgency=low
+
+  * debian/patches/40_remove_broken_help_buttons.patch:
+    - gkr/seahorse-gkr-item-properties.xml: Made widget helpbutton1 invisible
+      This disables the help button, which has no
+      associated content and leads to a yelp error (LP: #853137).
+    - gkr/seahorse-gkr-keyring.xml: Made widget helpbutton1 invisible
+      This disables the help button, which has no
+      associated content and leads to a yelp error.
+    - Note: I've chosen to leave the widget intact but invisible. When
+      the right help content is authored, then I believe this widget
+      should be exposed again.
+
+ -- Mike Carifio <[e-mail]>  Thu, 11 Oct 2012 15:46:56 -0400
+
 seahorse (3.2.2-0ubuntu2) precise; urgency=low
 
   * debian/patches/02_broken_search_filter.patch:

=== added file 'debian/patches/40_remove_broken_help_buttons.patch'
--- debian/patches/40_remove_broken_help_buttons.patch	1970-01-01 00:00:00 +0000
+++ debian/patches/40_remove_broken_help_buttons.patch	2012-10-18 13:59:24 +0000
@@ -0,0 +1,36 @@
+From: Michael Carifio <[e-mail]>
+Origin: vendor
+Subject: The page 'gkr-keyring' was not found in the document 'ghelp:seahorse'.
+Description: Clicking the help button in certain seahorse dialogs causes "page
+ not found" errors. This patch "removes" the offending buttons by making them
+ invisible.
+Bug-Ubuntu: https://launchpad.net/bugs/129303
+Forwarded: no
+
+---
+
+Patch metadata based on http://dep.debian.net/deps/dep3/ and 
+https://wiki.ubuntu.com/PackagingGuide/PatchSystems#Patch_Tagging_Guidelines
+
+--- a/gkr/seahorse-gkr-item-properties.xml
++++ b/gkr/seahorse-gkr-item-properties.xml
+@@ -362,7 +362,7 @@
+             <child>
+               <object class="GtkButton" id="helpbutton1">
+                 <property name="label">gtk-help</property>
+-                <property name="visible">True</property>
++                <property name="visible">False</property>
+                 <property name="can_focus">True</property>
+                 <property name="can_default">True</property>
+                 <property name="receives_default">False</property>
+--- a/gkr/seahorse-gkr-keyring.xml
++++ b/gkr/seahorse-gkr-keyring.xml
+@@ -148,7 +148,7 @@
+             <child>
+               <object class="GtkButton" id="helpbutton1">
+                 <property name="label">gtk-help</property>
+-                <property name="visible">True</property>
++                <property name="visible">False</property>
+                 <property name="can_focus">True</property>
+                 <property name="can_default">True</property>
+                 <property name="receives_default">False</property>

=== modified file 'debian/patches/series'
--- debian/patches/series	2012-04-11 16:06:48 +0000
+++ debian/patches/series	2012-10-18 13:59:24 +0000
@@ -3,3 +3,4 @@
 03_broken_search.patch
 08_force_ssh.patch
 30_preferences_menu.patch
+40_remove_broken_help_buttons.patch