Merge pull request #968 from ArcadeFever/feature/qt-macos-doc-reverts

MacOS Qt 5.15.2

BUILD.md

@@ -1,6 +1,6 @@
 # General Build Information
 
-*Last Updated on August 26, 2020*
+*Last Updated on January 16, 2021*
 
 ### OS Specific Build Guides
 
@@ -11,7 +11,7 @@
 
 ### Dependencies
 - [git](https://git-scm.com/downloads): >= 1.6  
-- [cmake](https://cmake.org/download/):  3.9
+- [cmake](https://cmake.org/download/):  3.9 (or greater up to 3.18.x)
 - [Python](https://www.python.org/downloads/): 3.6 or higher
 - [Node.JS](https://nodejs.org/en/): >= 12.13.1 LTS
     - Used to build the Screen Sharing executable.
@@ -57,6 +57,10 @@ For example, under Windows:
 
     set QT_CMAKE_PREFIX_PATH=C:\Qt\5.15.2\msvc2019_64\lib\cmake
 
+For example, under OSX:
+
+    export QT_CMAKE_PREFIX_PATH=/usr/local/Cellar/qt5/5.15.2/lib/cmake
+
 Note: You only need the following components checked under Qt 5.15.2 (select the "Custom Installation" option): 
 		"MSVC 2019 64-bit", "Qt WebEngine", and "Qt Script (Deprecated)".
 

BUILD_OSX.md

@@ -1,6 +1,6 @@
 # Build OSX
 
-*Last Updated on August 26, 2020*
+*Last Updated on January 16, 2021*
 
 Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only macOS specific instructions are found in this document.
 
@@ -10,6 +10,8 @@ Please read the [general build guide](BUILD.md) for information on dependencies
 
     brew install cmake openssl npm
 
+Note: cmake versions > 3.18.x have known problems building Vircadia, so alternatively you can download cmake 3.18.4 (or earlier versions) from [Github](https://github.com/Kitware/CMake/releases).   
+
 ### Python 3
 
 Download an install Python 3.6.6 or higher from [here](https://www.python.org/downloads/).  

hifi_qt.py

@@ -57,7 +57,7 @@ endif()
         if 'Windows' == system:
             self.qtUrl = self.assets_url + '/dependencies/vcpkg/qt5-install-5.15.2-windows.tar.gz'
         elif 'Darwin' == system:
-            self.qtUrl = self.assets_url + '/dependencies/vcpkg/qt5-install-5.12.3-macos.tar.gz%3FversionId=bLAgnoJ8IMKpqv8NFDcAu8hsyQy3Rwwz'
+            self.qtUrl = self.assets_url + '/dependencies/vcpkg/qt5-install-5.15.2-macos.tar.gz'
         elif 'Linux' == system:
             import distro
             dist = distro.linux_distribution()

tools/qt-builder/README.md

@@ -104,16 +104,13 @@ Verify again
 1.  nss (needed for qtwebengine)  
 `sudo apt-get install libnss3-dev -y`  
 
-### Mac
+### Mac  
-**TODO: Update this section for Qt 5.15.2**  
 1.  git >= 1.6  
 Check if needed `git --version`  
 Install from https://git-scm.com/download/mac  
 Verify again  
-1.  pkg-config  
+1.  install pkg-config, dbug-glib, and fontconfig  
-brew fontconfig dbus-glib stall pkg-config  
+brew install fontconfig dbus-glib pkg-config  
-1.  dbus-1  
-brew install dbus-glib  
 
 
 ## Build Process
@@ -288,26 +285,18 @@ Zip up this directory and upload it to Backtrace or other crash log handlng tool
 
 
 ### Mac  
-**TODO: Update this section for Qt 5.15.2**  
 
 #### Preparing source files  
-git clone --recursive git://code.qt.io/qt/qt5.git -b 5.12.3 --single-branch    
+git clone --recursive git://code.qt.io/qt/qt5.git -b 5.15.2 --single-branch    
-  
+
-*  Copy the **patches** folder to qt5  
+*  If you are compiling with MacOSX11.1.SDK or greater, edit qt5/qtwebengine/src/3rdparty/chromium/build/mac/find_sdk.py line 91 and replace "MacOSX(10" with "MacOSX(11".
-*   Apply the patches to Qt  
-`cd qt5`  
-`git apply --ignore-space-change --ignore-whitespace patches/aec.patch`  
-`git apply --ignore-space-change --ignore-whitespace patches/qtscript-crash-fix.patch`  
-`git apply --ignore-space-change --ignore-whitespace patches/mac-web-video.patch`  
-`cd ..`  
 
 #### Configuring
 `mkdir qt5-install`  
 `mkdir qt5-build`  
 `cd ../qt5-build`  
 
-`../qt5/configure -force-debug-info -opensource -confirm-license -qt-zlib -qt-libjpeg -qt-libpng -qt-freetype -qt-pcre -qt-harfbuzz -nomake examples -nomake tests -skip qttranslations -skip qtserialport -skip qt3d -skip qtlocation -skip qtwayland -skip qtsensors -skip qtgamepad -skip qtspeech -skip qtcharts -skip qtx11extras -skip qtmacextras -skip qtvirtualkeyboard -skip qtpurchasing -skip qtdatavis3d -no-warnings-are-errors  -no-pch -prefix ../qt5-install`  
+`../configure -force-debug-info -opensource -confirm-license -qt-zlib -qt-libjpeg -qt-libpng -qt-freetype -qt-pcre -qt-harfbuzz -nomake examples -nomake tests -skip qttranslations -skip qtserialport -skip qt3d -skip qtlocation -skip qtwayland -skip qtsensors -skip qtgamepad -skip qtcharts -skip qtx11extras -skip qtmacextras -skip qtvirtualkeyboard -skip qtpurchasing -skip qtdatavis3d -no-warnings-are-errors  -no-pch -prefix ../qt5-install`  
-**TODO: Remove `-skip qtspeech`**
 
 #### Make
 `make`  
@@ -315,17 +304,21 @@ git clone --recursive git://code.qt.io/qt/qt5.git -b 5.12.3 --single-branch
 
 #### Fixing
 1.  The *.prl* files have an absolute path that needs to be removed (see http://www.linuxfromscratch.org/blfs/view/stable-systemd/x/qtwebengine.html)  
-`cd ../qt5-install`  
+`cd` to the `qt5-install directory`  
 `find . -name \*.prl -exec sed -i -e '/^QMAKE_PRL_BUILD_DIR/d' {} \;`  
 `cd ..`  
-1.   Copy *qt.conf* to *qt5-install\bin*
+1.   Note: you may have additional files in qt5-install/lib and qt5-install/lib/pkg/pkgconfig that have your local build absolute path included.  Optionally you can fix these as well, but it will not effect the build if left alone.
+
+Add a *qt.conf* file.  
+1. Copy the file *qt5-build\qtbase\bin\qt.conf* to *qt5-install\bin*
+1. Edit the *qt.conf* file: replace all absolute URLs with relative URLs (beginning with .. or .)
 
 #### Uploading
-`tar -zcvf qt5-install-5.13.2-macos.tar.gz qt5-install`  
+`tar -zcvf qt5-install-5.15.2-macos.tar.gz qt5-install`  
-Upload qt5-install-5.13.2-macos.tar.gz to our Amazon S3 vircadia-public bucket, under the dependencies/vckpg directory
+Upload qt5-install-5.15.2-macos.tar.gz to our Amazon S3 vircadia-public bucket, under the dependencies/vckpg directory
 
-#### Creating symbols
+#### Creating symbols (optional)
-Run `python3 prepare-mac-symbols-for-backtrace.py qt5-install` to scan the qt5-build directory for any dylibs and execute dsymutil to create dSYM bundles.  After running this command the backtrace directory will be created.  Zip this directory up, but make sure that all dylibs and dSYM fiels are in the root of the zip file, not under a sub-directory.  This file can then be uploaded to backtrace here: https://highfidelity.sp.backtrace.io/p/Interface/settings/symbol/upload
+Run `python3 prepare-mac-symbols-for-backtrace.py qt5-install` to scan the qt5-build directory for any dylibs and execute dsymutil to create dSYM bundles.  After running this command the backtrace directory will be created.  Zip this directory up, but make sure that all dylibs and dSYM fiels are in the root of the zip file, not under a sub-directory.  This file can then be uploaded to backtrace or other crash log handling tool.
 
 ## Problems
 *configure* errors, if any, may be viewed in **config.log** and **config.summary**