[Development] How to write a ChangeLog entry

[Thiago Macieira]

Requesting comments below.

On segunda-feira, 20 de janeiro de 2014 12:39:04, Thiago Macieira wrote:
> Accessibility
> -------------
> 
>  - On Linux action names were returned as empty strings in AT-SPI
>    getActions, now returns the proper names.

Should I move this to QtGui? Or to QtWidgets? Or leave?

> QtBluetooth
> -----------
> 
>  - Documentation:
>    * Fix cases where device and service discovery classes emitted an error
>      signal but the human readable error string was not adjusted.

How is this a documentation issue? If it's a minor documentation fix, it 
probably isn't relevant for the changelog.

> QtCore
> ------
> 
>  - [QTBUG-35069] Fixed a bug that caused negative number input using '-' to
>    be rejected because the current locale uses e.g. 0x2212. QIntValidator
>    and QDoubleValidator now accepts both signs as well as the locale minus
>    sign.

Neither class is in QtCore. I'm moving this to QtWidgets.

>  - QProcess:
>    * [QTBUG-35357] Fixed a regression from Qt4 in QProcess that
>      prevented altering the pipe modes of stdin in the child process.

I've rewritten this text. Please confirm that it is accurate.

> QtGui
> -----
> 
>  - QKeySequence:
>    * [QTBUG-24406] return Qt::Key_unknown with invalid modifiers on OS X

I need help rewriting this one. What are invalid modifiers? Can the end-user 
press invalid modifiers? If the end-user can press invalid modifiers, how is 
this a good fix? If the end-user can't press them, what is the situation being 
fixed?

> QtMultimedia
> ------------
> 
>  - Android:
>    * [QTBUG-31422] Enable mediaplayer to read files from the Qt Resource
>      system.

Oops, rewritten as:

   * [QTBUG-31422] The mediaplayer can now read files from the Qt
     Resource system.

>    * [QTBUG-35564] Camera operations moved to a dedicated thread
>    * [QTBUG-35416] QVideoProbe support for camera

Please help rewriting these. And make sure the information is relevant to the 
user. Why should our users care that the operations have been moved to a 
thread? What's the benefit or the issue fixed?

> QtQuickControls
> ---------------
> 
>  - On Mac, ComboBox will now only get tab focus when it is editable.
>  - [QTBUG-35794] It is now possible to set currentIndex to -1 to clear
>    selection
>  - Editable Combobox now updates currentText when accepting a
>    substring of an existing value.

Please note the different spellings of Combobox. Is that a QML type? If it is, 
case is important. If it isn't, please add spaces and use correct plural rules 
("Editable combo boxes now update [...]")

I accidentally remove the "ComboBox" from the second entry. I've re-added at 
the end. ("clear selection in a ComboBox")

-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 190 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.qt-project.org/pipermail/development/attachments/20140120/8b24a35b/attachment.sig>