summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@qt.io>2016-09-23 15:02:39 +0200
committerKai Koehne <kai.koehne@qt.io>2016-10-04 13:29:01 +0000
commit06b85679becd39f1f051f53b108ba5d06e9bdcb8 (patch)
tree62f3cdd395046f94358e0b9e0026d2da96e9b4a9
parentdd2c7d9368827d5393b0b82a0a410e77bb69c058 (diff)
Document 3rd party code in Qt Wayland
Unfortunately the QPA plugin for Qt Wayland does not have a dedicated help, which is why everything is right now crammed into the compositor documentaton. Change-Id: Iddc4d67a817f2cc3bb334b2f040fa55230b5da4f Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
-rw-r--r--src/3rdparty/protocol/HPND_LICENSE.txt20
-rw-r--r--src/3rdparty/protocol/MIT_LICENSE.txt18
-rw-r--r--src/3rdparty/protocol/qt_attribution.json70
-rw-r--r--src/compositor/doc/src/qtwaylandcompositor-overview.qdoc14
4 files changed, 122 insertions, 0 deletions
diff --git a/src/3rdparty/protocol/HPND_LICENSE.txt b/src/3rdparty/protocol/HPND_LICENSE.txt
new file mode 100644
index 000000000..e7a4915da
--- /dev/null
+++ b/src/3rdparty/protocol/HPND_LICENSE.txt
@@ -0,0 +1,20 @@
+Permission to use, copy, modify, distribute, and sell this
+software and its documentation for any purpose is hereby granted
+without fee, provided that the above copyright notice appear in
+all copies and that both that copyright notice and this permission
+notice appear in supporting documentation, and that the name of
+the copyright holders not be used in advertising or publicity
+pertaining to distribution of the software without specific,
+written prior permission. The copyright holders make no
+representations about the suitability of this software for any
+purpose. It is provided "as is" without express or implied
+warranty.
+
+THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
+SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
+SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
diff --git a/src/3rdparty/protocol/MIT_LICENSE.txt b/src/3rdparty/protocol/MIT_LICENSE.txt
new file mode 100644
index 000000000..edc2e5fb5
--- /dev/null
+++ b/src/3rdparty/protocol/MIT_LICENSE.txt
@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/src/3rdparty/protocol/qt_attribution.json b/src/3rdparty/protocol/qt_attribution.json
new file mode 100644
index 000000000..327c408b9
--- /dev/null
+++ b/src/3rdparty/protocol/qt_attribution.json
@@ -0,0 +1,70 @@
+[
+ {
+ "Id": "wayland-protocol",
+ "Name": "Wayland Protocol",
+ "QDocModule": "qtwaylandcompositor",
+ "QtUsage": "Used in the Qt Wayland Compositor, and the Qt Wayland platform plugin.",
+
+ "Description": "Wayland is a protocol for a compositor to talk to its clients.",
+ "Homepage": "https://wayland.freedesktop.org",
+ "Version": "1.6.1",
+ "DownloadLocation": "https://cgit.freedesktop.org/wayland/wayland/tag/?id=1.6.1",
+ "LicenseId": "HPND",
+ "License": "HPND License",
+ "LicenseFile": "HPND_LICENSE.txt",
+ "Copyright": "Copyright © 2008-2011 Kristian Høgsberg
+ Copyright © 2010-2011 Intel Corporation
+ Copyright © 2012-2013 Collabora, Ltd."
+ },
+
+ {
+ "Id": "wayland-ivi-extension-protocol",
+ "Name": "Wayland IVI Extension Protocol",
+ "QDocModule": "qtwaylandcompositor",
+ "QtUsage": "Used in the Qt Wayland Compositor, and the Qt Wayland platform plugin.",
+
+ "Description": "\"Wayland IVI Extension\" is forked from IVI Layer Management to define a common set of APIs by wayland style protocol and provide reference implementation which can be loaded on Weston.",
+ "Homepage": "http://projects.genivi.org/wayland-ivi-extension",
+ "Version": "1.9.1",
+ "DownloadLocation": "http://git.projects.genivi.org/?p=wayland-ivi-extension.git;a=commit;h=44598504503eea5ac7f94c88477a5a78bda01f30",
+ "LicenseId": "MIT",
+ "License": "MIT License",
+ "LicenseFile": "MIT_LICENSE.txt",
+ "Copyright": "Copyright (C) 2013 DENSO CORPORATION
+Copyright (c) 2013 BMW Car IT GmbH"
+ },
+
+ {
+ "Id": "wayland-xdg-shell-protocol",
+ "Name": "Wayland XDG Shell Protocol",
+ "QDocModule": "qtwaylandcompositor",
+ "QtUsage": "Used in the Qt Wayland Compositor, and the Qt Wayland platform plugin.",
+
+ "Description": "The XDG-Shell protocol is an extended way to manage surfaces under Wayland compositors.",
+ "Homepage": "https://wayland.freedesktop.org",
+ "Version": "1.9.0",
+ "DownloadLocation": "https://cgit.freedesktop.org/wayland/weston/tag/?id=1.9.0",
+ "LicenseId": "MIT",
+ "License": "MIT License",
+ "LicenseFile": "MIT_LICENSE.txt",
+ "Copyright": "Copyright © 2008-2013 Kristian Høgsberg
+Copyright © 2013 Rafael Antognolli
+Copyright © 2013 Jasper St. Pierre
+Copyright © 2010-2013 Intel Corporation"
+ },
+
+ {
+ "Id": "wayland-txt-input-unstable",
+ "Name": "Wayland Text Input Protocol",
+ "QDocModule": "qtwaylandcompositor",
+ "QtUsage": "Used in the Qt Wayland Compositor, and the Qt Wayland platform plugin.",
+
+ "Description": "Adds support for text input and input methods to applications.",
+ "Homepage": "https://wayland.freedesktop.org",
+ "LicenseId": "HPND",
+ "License": "HPND License",
+ "LicenseFile": "HPND_LICENSE.txt",
+ "Copyright": "Copyright © 2012, 2013 Intel Corporation
+Copyright © 2015, 2016 Jan Arne Petersen"
+ }
+]
diff --git a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
index d2f0f6f40..05ab4fb03 100644
--- a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
+++ b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
@@ -62,6 +62,20 @@
Take a look at the \l{Qt Wayland Compositor Examples} for a demonstration on
how the APIs can be used to write custom display servers.
+ \section1 Licenses and Attributions
+
+ Qt Wayland Compositor and the Qt Wayland integration plugin
+ are available under commercial licenses from \l{The Qt Company}.
+ In addition, they are available under the
+ \l{GNU Lesser General Public License, version 3}, or
+ the \l{GNU General Public License, version 2}.
+ See \l{Qt Licensing} for further details.
+
+ Qt Wayland Compositor and the Qt Wayland integration plugin
+ use protocol definitions under following permissive licenses:
+
+ \generatelist{groupsbymodule attributions-qtwaylandcompositor}
+
\section1 API Reference
The Qt Wayland Compositor API can be used from C++ or QML.