After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 750718 - Improve documentation for deprecated properties
Improve documentation for deprecated properties
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
3.14.x
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2015-06-10 15:34 UTC by Simon Budig
Modified: 2015-06-11 10:46 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docs: Add deprecation notices for GtkAlignment properties (4.78 KB, patch)
2015-06-10 16:18 UTC, Emmanuele Bassi (:ebassi)
committed Details | Review
docs: Improve deprecation notices for GtkImageMenuItem properties (2.01 KB, patch)
2015-06-10 16:18 UTC, Emmanuele Bassi (:ebassi)
committed Details | Review
docs: Improve deprecation notice for rules-hint property (914 bytes, patch)
2015-06-10 16:18 UTC, Emmanuele Bassi (:ebassi)
committed Details | Review
docs: Improve deprecation notices for GtkMisc (2.81 KB, patch)
2015-06-10 16:18 UTC, Emmanuele Bassi (:ebassi)
committed Details | Review
docs: Improve deprecation notices for GtkSettings (1.91 KB, patch)
2015-06-10 16:18 UTC, Emmanuele Bassi (:ebassi)
committed Details | Review

Description Simon Budig 2015-06-10 15:34:23 UTC
I stumbled across a few deprecation warnings which did not point out a strategy to remedy the deprecation:

GtkTreeView:rules-hint  (deprecated since 3.14, no suggestion)

The other instances I cam across admittedly are for widgets deprecated as a whole:

GtkAlignment:top-padding             ->  -           (?)
GtkImageMenuItem:always-show-image   ->  -           (3.10)
GtkImageMenuItem:use-stock           ->  -           (3.10)
GtkMisc:xpad                         ->  -           (?)
GtkTreeView:rules-hint               ->  -           (3.14)

The following two are especially annoying since there apparently there is nothing I can do to fix them - I don't deal with GtkSetting.

GtkSettings:gtk-button-images        ->  -           (?)
GtkSettings:gtk-menu-images          ->  -           (?)
Comment 1 Emmanuele Bassi (:ebassi) 2015-06-10 16:17:53 UTC
(In reply to Simon Budig from comment #0)
> I stumbled across a few deprecation warnings which did not point out a
> strategy to remedy the deprecation:
> 
> GtkTreeView:rules-hint  (deprecated since 3.14, no suggestion)

Yep, there's no replacement for this. It's entirely up to the theme to decide whether or not to have zebra striping — which is exactly like it was before, since themes were responsible to implement it anyway. See bug 733312 for the rationale of why this was a bad API.

> The other instances I cam across admittedly are for widgets deprecated as a
> whole:
> 
> GtkAlignment:top-padding             ->  -           (?)

The whole GtkAlignment class is deprecated since 3.14, but properties should have separate deprecation notices.

> GtkImageMenuItem:always-show-image   ->  -           (3.10)
> GtkImageMenuItem:use-stock           ->  -           (3.10)

Same for GtkImageMenuItem.

> GtkMisc:xpad                         ->  -           (?)

Same for GtkMisc.

> The following two are especially annoying since there apparently there is
> nothing I can do to fix them - I don't deal with GtkSetting.
> 
> GtkSettings:gtk-button-images        ->  -           (?)
> GtkSettings:gtk-menu-images          ->  -           (?)

These are the result of using the stock icons API in GtkButton, GtkToolItem, or GtkMenuItem, or using deprecated classes like GtkImageMenuItem.
Comment 2 Emmanuele Bassi (:ebassi) 2015-06-10 16:18:09 UTC
Created attachment 304987 [details] [review]
docs: Add deprecation notices for GtkAlignment properties

We want people to port their code away from deprecated classes, and this
helps finding a replacement.
Comment 3 Emmanuele Bassi (:ebassi) 2015-06-10 16:18:15 UTC
Created attachment 304988 [details] [review]
docs: Improve deprecation notices for GtkImageMenuItem properties

Should help porting code away from the deprecated GtkImageMenuItem
class.
Comment 4 Emmanuele Bassi (:ebassi) 2015-06-10 16:18:20 UTC
Created attachment 304989 [details] [review]
docs: Improve deprecation notice for rules-hint property

Specify that the theme is wholly in control.
Comment 5 Emmanuele Bassi (:ebassi) 2015-06-10 16:18:26 UTC
Created attachment 304990 [details] [review]
docs: Improve deprecation notices for GtkMisc

Point to the replacement properties and functions.
Comment 6 Emmanuele Bassi (:ebassi) 2015-06-10 16:18:32 UTC
Created attachment 304991 [details] [review]
docs: Improve deprecation notices for GtkSettings

The button and menu item icons settings are deprecated; application
developers should control whether or not a widget should show an icon,
using the existing API.
Comment 7 Emmanuele Bassi (:ebassi) 2015-06-11 10:46:32 UTC
Attachment 304987 [details] pushed as 7157771 - docs: Add deprecation notices for GtkAlignment properties
Attachment 304988 [details] pushed as 5a61246 - docs: Improve deprecation notices for GtkImageMenuItem properties
Attachment 304989 [details] pushed as 56faf49 - docs: Improve deprecation notice for rules-hint property
Attachment 304990 [details] pushed as b493bf0 - docs: Improve deprecation notices for GtkMisc
Attachment 304991 [details] pushed as d11e812 - docs: Improve deprecation notices for GtkSettings