Merge branch 'master' into find_qmake_in_exepath

Author: hkollmann

.gitignore

@@ -36,3 +36,4 @@ Makefile*
 # QtCtreator CMake
 CMakeLists.txt.user
 
+.idea

.travis.yml

@@ -11,12 +11,18 @@ env:
 before_install:
   - ./tests/tests-environment.sh
 
+before_script:
+  # fetch all tags
+  - git fetch --unshallow
+
 script:
  - ./tests/tests-ci.sh
 
 after_success:
   - wget -c https://github.com/probonopd/uploadtool/raw/master/upload.sh
-  - bash ./upload.sh ./linuxdeployqt-*.AppImage
+  # quick fix for issue 223
+  - if [ "$TRAVIS_BRANCH" != "master" ]; then export TRAVIS_EVENT_TYPE=pull_request; fi
+  - bash ./upload.sh ./linuxdeployqt-*.AppImage*
 
 after_script:
   - "xpra stop :99"

CMakeLists.txt

@@ -0,0 +1,76 @@
+# CMake configuration for linuxdeployqt
+# Not meant to replace the qmake build system, but for use with CMake based IDEs.
+
+cmake_minimum_required(VERSION 3.2)
+
+project(linuxdeployqt)
+
+find_program(GIT git)
+
+# make sure Git revision ID and latest tag is not stored in the CMake cache
+# otherwise, one would have to reset the CMake cache on every new commit to make sure the Git commit ID is up to date
+unset(GIT_COMMIT CACHE)
+unset(GIT_LATEST_TAG CACHE)
+
+if("${GIT}" STREQUAL "GIT-NOTFOUND")
+    message(FATAL_ERROR "Could not find git")
+endif()
+
+# read Git revision ID and latest tag number
+execute_process(
+    COMMAND "${GIT}" rev-parse --short HEAD
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    OUTPUT_VARIABLE GIT_COMMIT
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE GIT_COMMIT_RESULT
+)
+if(NOT GIT_COMMIT_RESULT EQUAL 0)
+    message(FATAL_ERROR "Failed to determine git commit ID")
+endif()
+mark_as_advanced(GIT_COMMIT GIT_COMMIT_RESULT)
+
+execute_process(
+    COMMAND "${GIT}" rev-list --tags --skip=1 --max-count=1
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    OUTPUT_VARIABLE GIT_TAG_ID
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE GIT_TAG_ID_RESULT
+)
+if(NOT GIT_TAG_ID_RESULT EQUAL 0)
+    message(FATAL_ERROR "Failed to determine git tag ID")
+endif()
+mark_as_advanced(GIT_TAG_ID GIT_TAG_ID_RESULT)
+
+execute_process(
+    COMMAND "${GIT}" describe --tags ${GIT_TAG_ID} --abbrev=0
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+    OUTPUT_VARIABLE GIT_TAG_NAME
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE GIT_TAG_NAME_RESULT
+)
+if(NOT GIT_TAG_NAME_RESULT EQUAL 0)
+    message(FATAL_ERROR "Failed to determine git tag name")
+endif()
+mark_as_advanced(GIT_TAG_NAME GIT_TAG_NAME_RESULT)
+
+# set version and build number
+set(VERSION 1-alpha)
+if("$ENV{TRAVIS_BUILD_NUMBER}" STREQUAL "")
+    set(BUILD_NUMBER "<local dev build>")
+else()
+    set(BUILD_NUMBER "$ENV{TRAVIS_BUILD_NUMBER}")
+endif()
+
+# get current date
+execute_process(
+    COMMAND env LC_ALL=C date -u "+%Y-%m-%d %H:%M:%S %Z"
+    OUTPUT_VARIABLE DATE
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE DATE_RESULT
+)
+if(NOT DATE_RESULT EQUAL 0)
+    message(FATAL_ERROR "Failed to determine date string")
+endif()
+mark_as_advanced(DATE DATE_RESULT)
+
+add_subdirectory(tools/linuxdeployqt)

LICENSE.GPLv3

@@ -1,6 +1,6 @@
             GNU GENERAL PUBLIC LICENSE
 
- The Qt Toolkit is Copyright (C) 2016 The Qt Company Ltd.
+ The Qt Toolkit is Copyright (C) 2016-18 The Qt Company Ltd.
  Contact: http://www.qt.io/licensing/
 
  You may use, distribute and copy the Qt Toolkit under the terms of

LICENSE.LGPLv3

@@ -1,6 +1,6 @@
             GNU LESSER GENERAL PUBLIC LICENSE
 
- The Qt Toolkit is Copyright (C) 2016 The Qt Company Ltd.
+ The Qt Toolkit is Copyright (C) 2016-18 The Qt Company Ltd.
  Contact: http://www.qt.io/licensing/
 
  You may use, distribute and copy the Qt Toolkit under the terms of

README.md

@@ -1,6 +1,8 @@
 # linuxdeployqt [![Build Status](https://travis-ci.org/probonopd/linuxdeployqt.svg?branch=master)](https://travis-ci.org/probonopd/linuxdeployqt) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/93b4a359057e412b8a7673b4b61d7cb7)](https://www.codacy.com/app/probonopd/linuxdeployqt?utm_source=github.com&utm_medium=referral&utm_content=probonopd/linuxdeployqt&utm_campaign=Badge_Grade) [![discourse](https://img.shields.io/badge/forum-discourse-orange.svg)](http://discourse.appimage.org/t/linuxdeployqt-new-linux-deployment-tool-for-qt/57) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/probonopd/AppImageKit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![irc](https://img.shields.io/badge/IRC-%23AppImage%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=AppImage)
 
-This Linux Deployment Tool for Qt, `linuxdeployqt`, takes an application as input and makes it self-contained by copying in the Qt libraries and plugins that the application uses into a bundle. This can optionally be put into an [AppImage](http://appimage.org/), and, using [fpm](https://github.com/probonopd/linuxdeployqt/issues/9), into cross-distro deb and rpm packages.
+This Linux Deployment Tool, `linuxdeployqt`, takes an application as input and makes it self-contained by copying in the resources that the application uses (like libraries, graphics, and plugins) into a bundle. The resulting bundle can be distributed as an AppDir or as an [AppImage](https://appimage.org/) to users, or can be put into cross-distribution packages. It can be used as part of the build process to deploy applications written in C, C++, and other compiled languages with systems like `CMake`, `qmake`, and `make`. When used on Qt-based applications, it can bundle a specific minimal subset of Qt required to run the application.
+
+![](https://user-images.githubusercontent.com/2480569/34471167-d44bd55e-ef41-11e7-941e-e091a83cae38.png)
 
 ## Differences to macdeployqt
 This tool is conceptually based on the [Mac Deployment Tool](http://doc.qt.io/qt-5/osx-deployment.html), `macdeployqt` in the tools applications of the Qt Toolkit, but has been changed to a slightly different logic and other tools needed for Linux.
@@ -22,16 +24,17 @@ Please download __linuxdeployqt-x86_64.AppImage__ from the [Releases](https://gi
 Usage: linuxdeployqt app-binary [options]
 
 Options:
-   -verbose=<0-3>      : 0 = no output, 1 = error/warning (default), 2 = normal, 3 = debug
-   -no-plugins         : Skip plugin deployment
-   -appimage           : Create an AppImage
-   -no-strip           : Don't run 'strip' on the binaries
-   -bundle-non-qt-libs : Also bundle non-core, non-Qt libraries
-   -executable=<path>  : Let the given executable use the deployed libraries too
-   -qmldir=<path>      : Scan for QML imports to bundle from the given directory, determined by Qt's qmlimportscanner
-   -always-overwrite   : Copy files even if the target file exists
-   -qmake=<path>       : The qmake executable to use
-   -no-translations    : Skip deployment of translations
+   -verbose=<0-3>        : 0 = no output, 1 = error/warning (default), 2 = normal, 3 = debug
+   -no-plugins           : Skip plugin deployment
+   -appimage             : Create an AppImage
+   -no-strip             : Don't run 'strip' on the binaries
+   -bundle-non-qt-libs   : Also bundle non-core, non-Qt libraries
+   -executable=<path>    : Let the given executable use the deployed libraries too
+   -qmldir=<path>        : Scan for QML imports to bundle from the given directory, determined by Qt's qmlimportscanner
+   -always-overwrite     : Copy files even if the target file exists
+   -qmake=<path>         : The qmake executable to use
+   -no-translations      : Skip deployment of translations
+   -extra-plugins=<list> : List of extra plugins which should be deployed, separated by comma
 
 linuxdeployqt takes an application as input and makes it
 self-contained by copying in the Qt libraries and plugins that
@@ -40,12 +43,43 @@ the application uses.
 
 #### Simplest example
 
-Given that a desktop file should be provided with an AppImage, `linuxdeployqt` can use that to determine the parameters of the build.
+You'll need to provide the basic structure of an `AppDir` which should look something like this:
+```
+└── usr
+    ├── bin
+    │   └── your_app
+    ├── lib
+    └── share
+        ├── applications
+        │   └── your_app.desktop
+        └── icons
+            └── <theme>
+                └── <resolution> 
+                    └── apps 
+                        └── your_app.png
+```
+Replace `<theme>` and `<resolution>` with (for example) `hicolor` and `256x256` respectively; see [icon theme spec](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html) for more details.
+
+
+Using the desktop file `linuxdeployqt` can determine the parameters of the build.
 
-`linuxdeployqt ./path/to/appdir/usr/share/application_name.desktop`
+Where your desktop file would look something like:
+```
+[Desktop Entry]
+Type=Application
+Name=Amazing Qt App
+Comment=The best Qt Application Ever
+Exec=your_app
+Icon=your_app
+Categories=Office;
+```
+
+* Notice that both `Exec` and `Icon` only have file names.
+* Also Notice that the `Icon` entry does not include an extension.
 
-Where the _desktop_ file specifies the executable to be run (with `EXEC=`), the name of the applications and an icon.
-See [desktop file specification](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html).
+Read more about desktop files in the [freedesktop specification here](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html).
+
+Now you can say: `linuxdeployqt-continuous-x86_64.AppImage path/to/AppDir/usr/share/applications/your_app.desktop`
 
 For a more detailed example, see "Using linuxdeployqt with Travis CI" below.
 
@@ -78,6 +112,18 @@ find $HOME/build-*-*_Qt_* \( -name "moc_*" -or -name "*.o" -or -name "qrc_*" -or
 
 Alternatively, you could use `$DESTDIR`.
 
+#### Adding extra Qt plugins 
+
+If you want aditional plugins which the tool doesn't deploy, for a variety of reasons, you can use the -extra-plugins argument and include a list of plugins separated by a comma.  
+The plugins deployed are from the Qt installation pointed out by `qmake -v`.  
+You can deploy entire plugin directories, a specific directory or a mix of both.
+
+Usage examples: 
+
+1. `-extra-plugins=sqldrivers/libqmsql.so,iconengines/libqsvgicon.so`  
+2. `-extra-plugins=sqldrivers,iconengines/libqsvgicon.so`  
+3. `-extra-plugins=sqldrivers,iconengines,mediaservice,gamepads`
+
 ## Using linuxdeployqt with Travis CI
 
 A common use case for `linuxdeployqt` is to use it on Travis CI after the `make` command. The following example illustrates how to use `linuxdeployqt` with Travis CI. Create a `.travis.yml` file similar to this one (be sure to customize it, e.g., change `APPNAME` to the name of your application as it is spelled in the `Name=` entry of the `.desktop` file):
@@ -89,26 +135,34 @@ sudo: require
 dist: trusty
 
 before_install:
-    - sudo add-apt-repository ppa:beineri/opt-qt59-trusty -y
-    - sudo apt-get update -qq
+  - sudo add-apt-repository ppa:beineri/opt-qt593-trusty -y
+  - sudo apt-get update -qq
 
 install:
-    - sudo apt-get -y install qt59base
-    - source /opt/qt*/bin/qt*-env.sh
+  - sudo apt-get -y install qt59base
+  - source /opt/qt*/bin/qt*-env.sh
 
 script:
   - qmake CONFIG+=release PREFIX=/usr
   - make -j$(nproc)
   - make INSTALL_ROOT=appdir -j$(nproc) install ; find appdir/
-  - wget -c "https://github.com/probonopd/linuxdeployqt/releases/download/continuous/linuxdeployqt-continuous-x86_64.AppImage"
-  - chmod a+x linuxdeployqt*.AppImage
+  - wget -c -nv "https://github.com/probonopd/linuxdeployqt/releases/download/continuous/linuxdeployqt-continuous-x86_64.AppImage"
+  - chmod a+x linuxdeployqt-continuous-x86_64.AppImage
   - unset QTDIR; unset QT_PLUGIN_PATH ; unset LD_LIBRARY_PATH
-  - ./linuxdeployqt*.AppImage ./appdir/usr/share/applications/*.desktop -bundle-non-qt-libs
-  - ./linuxdeployqt*.AppImage ./appdir/usr/share/applications/*.desktop -appimage
+  - export VERSION=$(git rev-parse --short HEAD) # linuxdeployqt uses this for naming the file
+  - ./linuxdeployqt-continuous-x86_64.AppImage appdir/usr/share/applications/*.desktop -bundle-non-qt-libs
+  - ./linuxdeployqt-continuous-x86_64.AppImage appdir/usr/share/applications/*.desktop -appimage
 
 after_success:
-  - find ./appdir -executable -type f -exec ldd {} \; | grep " => /usr" | cut -d " " -f 2-3 | sort | uniq
-  - curl --upload-file ./APPNAME*.AppImage https://transfer.sh/APPNAME-git.$(git rev-parse --short HEAD)-x86_64.AppImage
+  - find appdir -executable -type f -exec ldd {} \; | grep " => /usr" | cut -d " " -f 2-3 | sort | uniq
+  - # curl --upload-file APPNAME*.AppImage https://transfer.sh/APPNAME-git.$(git rev-parse --short HEAD)-x86_64.AppImage
+  - wget -c https://github.com/probonopd/uploadtool/raw/master/upload.sh
+  - bash upload.sh APPNAME*.AppImage*
+  
+branches:
+  except:
+    - # Do not build tags that we create when we upload to GitHub Releases
+    - /^(?i:continuous)/
 ```
 
 When you save your change, then Travis CI should build and upload an AppImage for you. More likely than not, some fine-tuning will still be required.
@@ -124,6 +178,10 @@ find: `appdir/': No such file or directory
 
 If `qmake` does not allow for `make install` or does not install the desktop file and icon, then you need to change your `.pro` file it similar to https://github.com/probonopd/FeedTheMonkey/blob/master/FeedTheMonkey.pro.
 
+It is common on Unix to also use the build tool to install applications and libraries; for example, by invoking `make install`. For this reason, `qmake` has the concept of an install set, an object which contains instructions about the way a part of a project is to be installed.
+
+Please see the section "Installing Files" on http://doc.qt.io/qt-5/qmake-advanced-usage.html.
+
 ```
   - make INSTALL_ROOT=appdir install ; find appdir/
 ```
@@ -139,9 +197,9 @@ __CMake__ wants `DESTDIR` instead:
 __autotools__ (the dinosaur that spends precious minutes "checking...") wants `DESTDIR` too but insists on an absolute link which we can feed it using readlink:
 
 ```
-    - ./configure --prefix=/usr
-    - make -j$(nproc)
-    - make install DESTDIR=$(readlink -f appdir) ; find appdir/
+  - ./configure --prefix=/usr
+  - make -j$(nproc)
+  - make install DESTDIR=$(readlink -f appdir) ; find appdir/
 ```
 
 Caution if you encounter
@@ -159,9 +217,7 @@ The exception is that you are building Qt libraries that _should_ be installed t
 `linuxdeployqt` is great for upstream application projects that want to release their software in binary form to Linux users quickly and without much overhead. If you would like to see a particular application use `linuxdeployqt`, then sending a Pull Request may be an option to get the upstream application project to consider it. You can use the following template text for Pull Requests but make sure to customize it to the project in question.
 
 ```
-This PR, when merged, will compile this application on [Travis CI](https://travis-ci.org/) upon each `git push`, and upload an [AppImage](http://appimage.org/) to a temporary download URL on transfer.sh (available for 14 days). The download URL is toward the end of each Travis CI build log of each build (see below for how to set up automatic uploading to your GitHub Releases page).
-
-For this to work, you need to enable Travis CI for your repository as [described here](https://travis-ci.org/getting_started) __prior to merging this__, if you haven't already done so.
+This PR, when merged, will compile this application on [Travis CI](https://travis-ci.org/) upon each `git push`, and upload an [AppImage](http://appimage.org/) to your GitHub Releases page.
 
 Providing an [AppImage](http://appimage.org/) would have, among others, these advantages:
 - Applications packaged as an AppImage can run on many distributions (including Ubuntu, Fedora, openSUSE, CentOS, elementaryOS, Linux Mint, and others)
@@ -175,12 +231,12 @@ Providing an [AppImage](http://appimage.org/) would have, among others, these ad
 - Can optionally GPG2-sign your AppImages (inside the file)
 - Works on Live ISOs
 - Can use the same AppImages when dual-booting multiple distributions
-- Can be listed in the [AppImageHub](https://appimage.github.io/) central directory of available AppImages
-
-[Here is an overview](https://github.com/probonopd/AppImageKit/wiki/AppImages) of projects that are already distributing upstream-provided, official AppImages.
+- Can be listed in the [AppImageHub](https://appimage.github.io/apps) central directory of available AppImages
+- Can double as a self-extracting compressed archive with the `--appimage-extract` parameter
 
-__Please note:__ Instead of storing AppImage builds temporarily for 14 days each on transfer.sh, you could use GitHub Releases to store the binaries permanently. This way, they would be visible on the Releases page of your project. This is what I recommend. See https://docs.travis-ci.com/user/deployment/releases/. If you want to do this for continuous builds, also see https://github.com/probonopd/uploadtool.
+[Here is an overview](https://appimage.github.io/apps) of projects that are already distributing upstream-provided, official AppImages.
 
+__PLEASE NOTE:__ For this to work, you need to enable Travis CI for your repository as [described here](https://travis-ci.org/getting_started) __prior to merging this__, if you haven't already done so. Also, You need to set up `GITHUB_TOKEN` in Travis CI for this to work; please see https://github.com/probonopd/uploadtool.
 If you would like to see only one entry for the Pull Request in your project's history, then please enable [this GitHub functionality](https://help.github.com/articles/configuring-commit-squashing-for-pull-requests/) on your repo. It allows you to squash (combine) the commits when merging.
 
 If you have questions, AppImage developers are on #AppImage on irc.freenode.net.
@@ -189,6 +245,8 @@ If you have questions, AppImage developers are on #AppImage on irc.freenode.net.
 ## Projects using linuxdeployqt
 
 These projects are already using [Travis CI](http://travis-ci.org/) and linuxdeployqt to provide AppImages of their builds:
+- https://github.com/probonopd/ImageMagick
+- https://github.com/Subsurface-divelog/subsurface/
 - https://github.com/jimevins/glabels-qt
 - https://travis-ci.org/NeoTheFox/RepRaptor
 - https://github.com/electronpass/electronpass-desktop
@@ -211,6 +269,7 @@ These projects are already using [Travis CI](http://travis-ci.org/) and linuxdep
 - https://github.com/probonopd/linuxdeployqt/ obviously ;-)
 - https://github.com/xdgurl/xdgurl
 - https://github.com/QNapi/qnapi
+- https://github.com/m-o-s-t-a-f-a/dana
 
 This project is already using linuxdeployqt in a custom Jenkins workflow:
 - https://github.com/appimage-packages/

tests/QtWebEngineApplication/main.cpp

@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2016-18 The Qt Company Ltd.
 ** Contact: http://www.qt.io/licensing/
 **
 ** This file is part of the examples of the Qt Toolkit.

tests/QtWebEngineApplication/main.qml

@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2016-18 The Qt Company Ltd.
 ** Contact: http://www.qt.io/licensing/
 **
 ** This file is part of the examples of the Qt Toolkit.