Skip to content

Commit

Permalink
Doc: Add porting guide documents
Browse files Browse the repository at this point in the history
Also add existing such docs to the new document group

Task-number: QTBUG-84051
Change-Id: I76f033f0846e09943f249d2beeb1606869eef382
Reviewed-by: Topi Reiniö <[email protected]>
  • Loading branch information
paulwicking committed Sep 16, 2020
1 parent 227e364 commit c5f611c
Show file tree
Hide file tree
Showing 11 changed files with 418 additions and 0 deletions.
46 changes: 46 additions & 0 deletions src/concurrent/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page concurrent-changes-qt6.html
\title Porting to Qt 6 - Qt Concurrent
\ingroup porting-guides-5-to-6
\brief Migrate Qt Concurrent to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt Concurrent, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
2 changes: 2 additions & 0 deletions src/corelib/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
/*!
\page qtcore-changes-qt6.html
\title Porting to Qt 6 - Qt Core
\ingroup porting-guides-5-to-6
\brief Migrate Qt Core to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.
Expand Down
46 changes: 46 additions & 0 deletions src/dbus/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page dbus-changes-qt6.html
\title Porting to Qt 6 - Qt DBus
\ingroup porting-guides-5-to-6
\brief Migrate Qt DBus to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt DBus, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
46 changes: 46 additions & 0 deletions src/gui/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page gui-changes-qt6.html
\title Porting to Qt 6 - Qt GUI
\ingroup porting-guides-5-to-6
\brief Migrate Qt GUI to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt GUI, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
46 changes: 46 additions & 0 deletions src/network/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page network-changes-qt6.html
\title Porting to Qt 6 - Qt Network
\ingroup porting-guides-5-to-6
\brief Migrate Qt Network to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt Network, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
46 changes: 46 additions & 0 deletions src/opengl/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page opengl-changes-qt6.html
\title Porting to Qt 6 - Qt OpenGL
\ingroup porting-guides-5-to-6
\brief Migrate Qt OpenGL to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt OpenGL, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
46 changes: 46 additions & 0 deletions src/printsupport/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page printsupport-changes-qt6.html
\title Porting to Qt 6 - Qt Print Support
\ingroup porting-guides-5-to-6
\brief Migrate Qt Print Support to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt Print Support, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
2 changes: 2 additions & 0 deletions src/sql/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
/*!
\page qtsql-changes-qt6.html
\title Porting to Qt 6 - Qt Sql
\ingroup porting-guides-5-to-6
\brief Migrate Qt Sql to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.
Expand Down
46 changes: 46 additions & 0 deletions src/testlib/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page testlib-changes-qt6.html
\title Porting to Qt 6 - Qt Test
\ingroup porting-guides-5-to-6
\brief Migrate Qt Test to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt Test, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
46 changes: 46 additions & 0 deletions src/widgets/doc/src/qt6-changes.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
\page widgets-changes-qt6.html
\title Porting to Qt 6 - Qt Widgets
\ingroup porting-guides-5-to-6
\brief Migrate Qt Widgets to Qt 6.

Qt 6 is a result of the conscious effort to make the framework more
efficient and easy to use.

We try to maintain binary and source compatibility for all the public
APIs in each release. But some changes were inevitable in an effort to
make Qt a better framework.

In this topic we summarize those changes in Qt Widgets, and provide
guidance to handle them.

\section1 ADD STUFF HERE

*/
Loading

0 comments on commit c5f611c

Please sign in to comment.