[Development] Changelogs for 5.3.0

[Thiago Macieira]

Here's some editing I've done. This serves as suggestions for other editors.

Everyone who has committed to qtbase please read through because I have 
editing questions for you.

Em ter 22 abr 2014, às 15:13:41, Thiago Macieira escreveu:
>  GLES3 and desktop OpenGL are now fully supported with EGL
> ----------------------------------------------------------
> 
>  - [QTBUG-37332] 

Source:
    [ChangeLog] GLES3 and desktop OpenGL are now fully supported with EGL

>  Native (that is, not distance field based) text
> rendering is now functional on OpenGL 3.2+ core profiles too.
> ----------------------------------------------------------------------------
> ----------------------------------
> 
>  - [QTBUG-36993] 

Source:
    [ChangeLog] Native (that is, not distance field based) text
    rendering is now functional on OpenGL 3.2+ core profiles too.

The above two are actually properly formatted changelogs, but they don't 
specify which area you'd like them in. I've placed them under [QtGui].

> 
>  QFileSelector: the identifier for OS X has been changed back
> to 'osx' from 'mac', and 'mac' and 'darwin' have now been added as
> selectors for Darwin OS (which is the base of both OS X and iOS).
> ----------------------------------------------------------------------------
> ----------------------------------------------------------------------------
> ------------------------------------------
> 
>  - [QTBUG-35073] 

Moved to [QtCore][QFileSelector]

> Android
> -------

>  - [QTBUG-34650] Rework the raster and opengl implementation.
>    [ChangeLog][Android] Create a single android platform plugin.

Deleted. This is useless information to the end user. It's also in the 
imperative -- why are you telling the user to rework the implementation?

It's also missing an empty line between the two changelogs.

>  - [QTBUG-30652] Allow the developers to define a splash screen which will
>    be visible until the first window is created.

"It is now possible to define ..."

>  - [QTBUG-33704] Speed up first time directory listing in assets by using
>    pregenerated entry list.

"Sped up"

>  - [QTBUG-36974] Fixed double click events

Requires more information. Were all double click events so bad that they were 
unusable?

Deleted until I get more information.

> QDrag
> -----
> 
>  - Windows:
>    * Fixed Drag and Drop driven by touch-synthesized mouse events.

Moved to [QtGui][QDrag] and added "on Windows".

> QTextDocument
> -------------
> 
>  - [QTBUG-33336] Add support for empty inline elements in block tags.

"Added'

> QWidget
> -------
> 
>  - Windows:
>    * [QTBUG-21371][QTBUG-4397] QWidget::restoreGeometry() now restores
>      maximized/full screen widgets to the correct screen.

Moved to [QtGui][QWidget].

>  - Important Behavior Changes:
>    * Running Qt applications that are setuid has been prevented. If you
>      really need to do this then you can call
>      QCoreApplication::setSetuidAllowed(true) before creating the
>      QCoreApplication instance.

Moved to [Important Behavior Changes] (out of QtCore). Changed "has been 
prevented" to "is no longer allowed by default".

>  - JSON:
>    * QJsonValue::fromVariant() will now convert single-precision Floats
>      into Doubles instead of Strings

Moved to [QtCore][QJsonValue]

> 
>  - Logging:
>    * Allow qCDebug macros to be used in a printf style.

"It's now possible for the..."

>    * Enable qCDebug's for all categories except qt one's

"All qCDebug categories are enabled by default, except for Qt's own 
categories"

>    * Make Q_LOGGING_CATEGORY and Q_DECLARE_LOGGING_CATEGORY return a const
>      object.

Removed "make" (why are you telling the user to do that?) and made it "now 
return".

>  - Objective-C:
>    * Added NSData/CDataRef converters for QByteArray

Moved to [QtCore][QByteArray]

>  - QHash:
>    * Allowed QFont to be used as a key in QHash/QSet.

Dropped, since there's a nicer version in [QtGui][QFont].

>  - QHash/QSet:
>    * Allowed to use float, double and long double as QHash/QSet keys.

"Added qHash overloads for float, double and long double"

>  - QJsonArray:
>    * Added convenience methods to QJsonArray for appending QJsonValues
> 
>  - QJsonValue:
>    * Added constructor to QJsonValue for const char *
> 
>  - QMargins:
>    * Added missing addition and subtraction operators.
> 
>  - QPA/Android:
>    * [QTBUG-36025] Fixed a memory leak in the clipboard

Moved to Android changes. Why was this in QtCore in the first place? QPA is a 
QtGui technology...

> QtDBus
> ------
> 
>  - Important Behavior Changes:
>    * QtDBus adaptors now include the PropertiesChanged signal in
>      introspection data

Removed the "important behaviour changes" heading, leaving it directly under 
[QtDBus].

> QtGui
> -----
> 
>  - [QTBUG-35220] Support reading bmp images with alpha channel

"Reading bmp images with alpha channel is now supported"

>  - Accessibility on Linux reported all objects as being editable instead of
>    just editable text items.

Requires rewriting. Are you telling us of what the previous state was? Or what 
the current state is?

Deleted until new text comes in.

>  - Accessibility:
>    * Allow assistive apps such as VoiceOver to set the focus on widgets and
>      controls.

Please avoid using "Allow" in changelogs. Rewritten to "Assistive apps such... 
can now set focus..."

>  - QGuiApplication:
>    * Restore support for -title command line argument on X11, add
>      -qwindowtitle on all platforms.

"Restored... and added..."

>  - QImage:
>    * Rvalue qualified mirrored and rgbSwapped methods for inline
>      conversions Change-Id: I4ffb658bf620dfc472d9db14c1aa70291c1fd842
>      Reviewed-by: Gunnar Sletta <gunnar.sletta at jollamobile.com>
>    * Added rvalue qualified convertToFormat method for in-place conversion

Merged those two into one "Added rvalue-qualified overloads for mirrored(), 
rgbSwapped() and convertToFormat(), allowing in-place conversion in some 
cases"

>  - QTextDocumentLayout:
>    * [QTBUG-36743] Emit updateBlock signal in QTextDocumentLayout.

"The updateBlock() signal is now emitted".

This implies we had a signal that was never emitted before. If that's not 
correct, please provide a better entry.

By the way, that's a bad signal name. Signals are supposed to indicate state 
changes. "Update block" has a verb in the imperative for a core component, 
which is naming rule for slots. Please deprecate this signal and introduce a 
better one.

>  - QWidget:
>    * [QTBUG-25831] MouseButtonDblClick: Do not send the 2nd
>      MouseButtonPress event to Widgets. Restore Qt4 behavior in sequence of
>      mouse events delivered to widget windows and their children.

Rewritten to "Restored the Qt 4 behavior in the sequence of events that are 
delivered to widget windows and their children when a mouse double click 
happens: the second MouseButtonPress event from Qt 5.0-5.2 is no longer sent"

And moved to [QtWidget][QWidget].

>  - Windows:
>    * Introduce experimental direct2d platform plugin for Windows. This
>      plugin shares most code with the current windows plugin, but
>      substitutes a direct2d-based paint engine for window backing stores
>      and pixmaps.

Moved to the Windows platform-specific changes. Changed to "Introduced"

> QtSql
> -----
> 
>  - [QTBUG-12186] Fixed the order of values with positional binding in a
>    QSqlQuery Reviewed-by: Andy Shaw <andy.shaw at digia.com> Reviewed-by: Mark
>    Brand <mabrand at mabrand.nl>

Hmpf.

>  - QSQLITE:
>    * Enable creating temporary databases

"Creating temporary databases is now possible"

Would be nice if this explained *how* it is possible or whether it was a 
bugfix. If it was a bugfix, this should read "Fixed a bug that prevented...". If 
it's a new API, a few words explaining how to do it should be added.

> QtTest
> ------
> 
>  - Windows:
>    * [QTBUG-35743] Use correct UTF-8 encoding for XML test results on
>      platforms with different console encoding. Change-Id:
>      Ice9d03192098f931e5dac358928e0c4421ab715e Reviewed-by: Frederik
>      Gladhorn <frederik.gladhorn at digia.com>

Hrm.

Please explain the "on platforms" part. This is under a Windows heading. Which 
platforms besides Windows does this apply to?

> QtWidget
> --------
> 
>  - OS X:
>    * [QTBUG-36178] Fixes an issue where stay on top widgets would cover
>      their own children

Moved to QtWidgets (plural!), under QWidget, added dashes to stay-on-top, 
added "on OS X", changed to "Fixed" (past).

> QtWidgets
> ---------
> 
>  - Mac:
>    * [QTBUG-33716] QWidgets embedded in QGraphicsProxyWidget are no longer
>      sent close events when the app is closed.

Moved to [QtWidgets][QWidget] and added "on OS X".

>    * [QTBUG-36692] Fixed incorrect appearance of QDateEdit with
>      calendarPopup enabled.

Moved to to [QtWidgets][QDateEdit] and added "on OS X".

>  - QAbstractSpinBox:
>    * [QTBUG-5142] QTBUG-5142 - This will allow a group (thousand) separator
>      to be shown in QSpinBox and QDoubleSpinBox widgets.

Rewritten to "QSpinBox and QDoubleSpinBox widgets can now show the group 
(thousands) separators"

>  - QColorDialog:
>    * Ensured QColorDialog::DontUseNativeDialog is respected when showing
>      the dialog. Reviewed-by: Friedemann Kleint
>      <Friedemann.Kleint at digia.com>

Bleh.

>  - QLineEdit:
>    * [QTBUG-31669] A blinking cursor in the middle over horizontally
>      centered placeholder text looks bad. Thus, horizontally centered
>      content is now considered as an exception and the placeholder text is
>      hidden when the line edit is focused.

Requires rewriting. Deleted until I get a better entry.

>  - QMenu:
>    * [QTBUG-20094] Enable sloppy submenu mouse navigation Change-Id:
>      I134c87e348d98d1f46055e0bfef2b4a4a3d2993a Reviewed-by: Shawn Rutledge
>      <shawn.rutledge at digia.com> Reviewed-by: Jens Bache-Wiig
>      <jens.bache-wiig at digia.com> Reviewed-by: Marc Mutz
>      <marc.mutz at kdab.com>

"Enabled".

>  - QMenu / Windows:
>    * [QTBUG-36142] Correctly use text color set by style sheet for menu
>      items.
>    * [QTBUG-36218] Fixed position of menu gutter when using a custom widget
>      action.

Both merged into QMenu and added "on Windows" where appropriate.

>  - QPlainTextEdit:
>    * Added find method overload using QRegExp

Why are we adding QRegExp overloads? Where's the QRegularExpression overload? 
Please reply in the QtWidget header diff email.

>  - QTBUG-4714:
>    * [QTBUG-4714] Use the grid size for wordwrapping when available in icon
>      mode Task-number: QTBUG-4714 Change-Id:
>      I2cb63809d3ee8bd262f38bc11de91df9ff5cf237 Reviewed-by: Stephen Kelly
>      <stephen.kelly at kdab.com>

Deleted. I have no idea what this is for. If it's important, please provide a 
better description and the class name it applies to.

>  - QTextEdit:
>    * Added find method overload using QRegExp

Same as for QPlainTextEdit.

> Text
> ----
> 
>  - [QTBUG-36444] Fixed off-by-one in the height of text background.

Moved to [QtWidgets][Text support].

> Widgets
> -------
> 
>  - QScrollArea:
>    * [QTBUG-36314] Respect scrollbar setting for click-position on Mac.

Moved to [QtWidgets][QScrollArea] and rewritten to "The setting for click 
position is now respected on OS X".

-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center