From f788931c26d33e9cdebd2352d2a14ac004967daf Mon Sep 17 00:00:00 2001 From: Michael Brasser Date: Tue, 30 Apr 2019 12:56:35 -0500 Subject: Document protocol versioning behavior Change-Id: If296ff36382d38ee30ff51030a81e33bd4307148 Reviewed-by: Brett Stottlemyer --- .../doc/src/remoteobjects-compatibility.qdoc | 53 ++++++++++++++++++++++ src/remoteobjects/doc/src/remoteobjects-index.qdoc | 1 + 2 files changed, 54 insertions(+) create mode 100644 src/remoteobjects/doc/src/remoteobjects-compatibility.qdoc diff --git a/src/remoteobjects/doc/src/remoteobjects-compatibility.qdoc b/src/remoteobjects/doc/src/remoteobjects-compatibility.qdoc new file mode 100644 index 0000000..536857b --- /dev/null +++ b/src/remoteobjects/doc/src/remoteobjects-compatibility.qdoc @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2019 Ford Motor Company +** 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 qtremoteobjects-compatibility.html +\title Qt Remote Objects Protocol Versioning + +Qt Remote Objects uses an internal protocol to pass data between processes +and/or devices. The same protocol version needs to be used by all parties: if +there is a mismatch, the connecting node will output a warning and the host +node will not send any data. + +Currently released versions: + +\table +\header + \li Protocol Version + \li Qt Version +\row + \li <1.2 + \li Used during QtRO's tech preview phase. +\row + \li 1.2 + \li 5.12.0 +\row + \li 1.3 + \li 5.12.4 +\endtable +*/ diff --git a/src/remoteobjects/doc/src/remoteobjects-index.qdoc b/src/remoteobjects/doc/src/remoteobjects-index.qdoc index 46e4d9b..36bed85 100644 --- a/src/remoteobjects/doc/src/remoteobjects-index.qdoc +++ b/src/remoteobjects/doc/src/remoteobjects-index.qdoc @@ -101,6 +101,7 @@ See \l{Qt Licensing} for further details. \li \l {Remote Object Interaction} \li \l {Using Qt Remote Objects} \li \l {Troubleshooting Qt Remote Objects} + \li \l {Qt Remote Objects Protocol Versioning} \endlist -- cgit v1.2.3