Merge pull request #58 from rdumusc/master

Release Deflect 0.8.0

Author: Raphael Dumusc

.gitexternals

@@ -1,2 +1,2 @@
 # -*- mode: cmake -*-
-# CMake/common https://github.com/Eyescale/CMake.git 77c8475
+# CMake/common https://github.com/Eyescale/CMake.git 9a0223f

CMake/Deflect.cmake

@@ -1,21 +1,5 @@
-set(DEFLECT_PACKAGE_VERSION 0.5)
-set(DEFLECT_REPO_URL https://github.com/BlueBrain/Deflect.git)
-
-set(QT5CONCURRENT_CMAKE_INCLUDE "BEFORE SYSTEM")
-set(DEFLECT_DEPENDS REQUIRED Boost LibJpegTurbo Qt5Concurrent Qt5Core Qt5Network
-                             Qt5Widgets
-                    OPTIONAL GLUT Servus OpenGL)
-set(DEFLECT_BOOST_COMPONENTS "date_time program_options unit_test_framework serialization system thread")
 set(DEFLECT_DEB_DEPENDS libjpeg-turbo8-dev libturbojpeg freeglut3-dev
   libboost-test-dev libboost-date-time-dev libboost-program-options-dev
-  libboost-serialization-dev libboost-system-dev libboost-thread-dev)
-set(DEFLECT_PORT_DEPENDS boost freeglut)
-set(DEFLECT_SUBPROJECT ON)
-
-if(CI_BUILD_COMMIT)
-  set(DEFLECT_REPO_TAG ${CI_BUILD_COMMIT})
-else()
-  set(DEFLECT_REPO_TAG master)
-endif()
-set(DEFLECT_FORCE_BUILD ON)
-set(DEFLECT_SOURCE ${CMAKE_SOURCE_DIR})
+  libboost-serialization-dev libboost-system-dev libboost-thread-dev
+  qtbase5-dev)
+set(DEFLECT_PORT_DEPENDS boost freeglut qt5-mac)

CMake/GitExternal.cmake

@@ -10,9 +10,9 @@
 #  * Provides function
 #      git_external(<directory> <giturl> <gittag> [VERBOSE,SHALLOW]
 #        [RESET <files>])
-#    which will check out directory in CMAKE_SOURCE_DIR (if relative)
+#    which will check out directory in COMMON_SOURCE_DIR if relative,
 #    or in the given absolute path using the given repository and tag
-#    (commit-ish).
+#    if commit-ish.
 #
 # Options which can be supplied to the function:
 #  VERBOSE, when present, this option tells the function to output
@@ -43,6 +43,9 @@
 #    If set, a remote called 'user' is set up for github repositories, pointing
 #    to [email protected]:<user>/<project>. Also, this remote is used by default
 #    for 'git push'.
+# COMMON_SOURCE_DIR
+#   Download location of the source code of subprojects and externals.
+#   Defaults to CMAKE_SOURCE_DIR.
 
 
 if(NOT GIT_FOUND)
@@ -53,8 +56,15 @@ if(NOT GIT_EXECUTABLE)
 endif()
 
 include(CMakeParseArguments)
+
 option(GIT_EXTERNAL_VERBOSE "Print git commands as they are executed" OFF)
 
+set(COMMON_SOURCE_DIR "${CMAKE_SOURCE_DIR}" CACHE PATH
+  "Location of common directory of all sources")
+set(__common_source_dir ${COMMON_SOURCE_DIR})
+get_filename_component(__common_source_dir ${__common_source_dir} ABSOLUTE)
+file(MAKE_DIRECTORY ${__common_source_dir})
+
 if(NOT GITHUB_USER AND DEFINED ENV{GITHUB_USER})
   set(GITHUB_USER $ENV{GITHUB_USER} CACHE STRING
     "Github user name used to setup remote for 'user' forks")
@@ -95,7 +105,7 @@ function(GIT_EXTERNAL DIR REPO tag)
   endif()
 
   if(NOT IS_ABSOLUTE "${DIR}")
-    set(DIR "${CMAKE_SOURCE_DIR}/${DIR}")
+    set(DIR "${COMMON_SOURCE_DIR}/${DIR}")
   endif()
   get_filename_component(NAME "${DIR}" NAME)
   get_filename_component(GIT_EXTERNAL_DIR "${DIR}/.." ABSOLUTE)
@@ -151,11 +161,7 @@ function(GIT_EXTERNAL DIR REPO tag)
       OUTPUT_QUIET ERROR_QUIET WORKING_DIRECTORY "${DIR}")
   endif()
 
-  if(COMMON_SOURCE_DIR)
-    file(RELATIVE_PATH __dir ${COMMON_SOURCE_DIR} ${DIR})
-  else()
-    file(RELATIVE_PATH __dir ${CMAKE_SOURCE_DIR} ${DIR})
-  endif()
+  file(RELATIVE_PATH __dir ${COMMON_SOURCE_DIR} ${DIR})
   string(REGEX REPLACE "[:/\\.]" "-" __target "${__dir}")
   if(TARGET ${__target}-rebase)
     return()
@@ -301,11 +307,11 @@ if(EXISTS ${GIT_EXTERNALS} AND NOT GIT_EXTERNAL_SCRIPT_MODE)
           file(WRITE "${GIT_EXTERNAL_SCRIPT}" "
 include(\"${CMAKE_CURRENT_LIST_DIR}/GitExternal.cmake\")
 execute_process(COMMAND \"${GIT_EXECUTABLE}\" fetch origin -q
-  WORKING_DIRECTORY \"${DIR}\")
+  WORKING_DIRECTORY \"${COMMON_SOURCE_DIR}/${DIR}\")
 execute_process(
   COMMAND \"${GIT_EXECUTABLE}\" show-ref --hash=7 refs/remotes/origin/master
   OUTPUT_VARIABLE newref OUTPUT_STRIP_TRAILING_WHITESPACE
-  WORKING_DIRECTORY \"${DIR}\")
+  WORKING_DIRECTORY \"${COMMON_SOURCE_DIR}/${DIR}\")
 if(newref)
   file(APPEND ${GIT_EXTERNALS} \"# ${DIR} ${REPO} \${newref}\\n\")
   git_external(${DIR} ${REPO} \${newref})

README.md

@@ -14,11 +14,17 @@ Deflect provides the following functionality:
 * Compressed or uncompressed streaming
 * Fast multi-threaded JPEG compression (using libjpeg-turbo)
 
+DeflectQt (optional) provides the following additional functionality:
+
+* Create QML applications which render offscreen and stream and receive events
+  via Deflect
+
 The following applications are provided which make use of the streaming API:
 
 * DesktopStreamer: A small utility that lets you stream your desktop.
 * SimpleStreamer: A simple example to demonstrate streaming of an OpenGL
   application.
+* QmlStreamer (optional): An offscreen application to stream any given qml file.
 
 ## Building from source
 
@@ -32,8 +38,7 @@ The following applications are provided which make use of the streaming API:
 
 ## ChangeLog
 
-To keep track of the changes between releases check the
-[changelog](doc/Changelog.md).
+To keep track of the changes between releases check the @ref Changelog.
 
 ## About
 

apps/QmlStreamer/CMakeLists.txt

@@ -5,4 +5,4 @@
 set(QMLSTREAMER_SOURCES main.cpp)
 set(QMLSTREAMER_RESOURCES resources.qrc)
 set(QMLSTREAMER_LINK_LIBRARIES DeflectQt)
-common_application(QmlStreamer)
+common_application(qmlstreamer)

doc/Changelog.md

@@ -3,19 +3,19 @@ Changelog {#Changelog}
 
 ## Deflect 0.8
 
-### 0.8.0 (git master)
-* Fix: ZeroConf record for server announces hostname instead of (wrong) port
-* Fix: send compressed JPEG images from correct thread, might fix crashes/hangs
-* Fix [#45](https://github.com/BlueBrain/Deflect/issues/45): Mouse position for
-  DesktopStreamer is rendered correctly on Retina displays
-* Fix interaction with DesktopStreamer on OSX where one click resulted in two
-  clicks
-* Added MTQueue class, moved from DisplayCluster
+### 0.8.0 (04-11-2015)
 * Added DeflectQt library to create QML applications which render offscreen and
   stream and receive events via Deflect
 * Added deflect::Stream::sendSizeHints()
+* Added MTQueue class, moved from DisplayCluster
 * Fix [54](https://github.com/BlueBrain/Deflect/issues/54): ZeroConf discovery
-  in DesktopStreamer uses hostname instead of instance name. 
+  in DesktopStreamer uses hostname instead of instance name
+* Fix interaction with DesktopStreamer on OSX where one click resulted in two
+  clicks
+* Fix [45](https://github.com/BlueBrain/Deflect/issues/45): Mouse position for
+  DesktopStreamer is rendered correctly on Retina displays
+* Fix: send compressed JPEG images from correct thread, might fix crashes/hangs
+* Fix: ZeroConf record for server announces hostname instead of (wrong) port
 
 ## Deflect 0.7