[Development] Documenting Qt 6 API breakages

[Eskil Abrahamsen Blomfeldt]

Hi,

FWIW, the page I made just replaced the Qt 4 to Qt 5 porting guide, so I didn't put any thought into whether we should change the existing structure. As long as they are accessible from a general "porting" document, I think it is a good idea to move specifics into their respective modules. That would make it possible to do the documentation as part of the change as well, instead of as an afterthought.


Eskil Abrahamsen Blomfeldt
Senior Manager, Graphics

The Qt Company
Sandakerveien 116
0484 Oslo, Norway
eskil.abrahamsen-blomfeldt at qt.io
http://qt.io

________________________________
Fra: Development <development-bounces at qt-project.org> på vegne av Kai Köhne <Kai.Koehne at qt.io>
Sendt: onsdag 27. mai 2020 16:48
Til: development at qt-project.org <development at qt-project.org>
Emne: [Development] Documenting Qt 6 API breakages

Hi,

We should start documenting the API changes that Qt 6.0 brings soon. This will allow getting people getting an overview, help early adopters, and will give us time to improve the documentation before the release.

Now I see that there are different paths taken:
- Eskil and others have started listing changes in a page in the qtdoc repository, https://doc-snapshots.qt.io/qt6-dev/sourcebreaks.html
- I created a skeleton for Qt Core changes in the qtbase repository: https://codereview.qt-project.org/c/qt/qtbase/+/299664 .

I wasn't aware of the existing page in qtdoc; Anyhow, from past experience I prefer having the documentation nearby the actual code. I therefore would like move the existing sections about Qt Quick, Qt OpenGL to the respective module documentation and let https://doc-snapshots.qt.io/qt6-dev/sourcebreaks.html just link to the module documentation pages.

Thoughts?

Kai

--
Kai Köhne, Director R&D | The Qt Company

The Qt Company GmbH, Erich-Thilo-Straße 10, D-12489 Berlin
Geschäftsführer: Mika Pälsi, Juha Varelius, Mika Harjuaho
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B

_______________________________________________
Development mailing list
Development at qt-project.org
https://lists.qt-project.org/listinfo/development
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.qt-project.org/pipermail/development/attachments/20200610/d4be4935/attachment.html>