From 27e24a733b8a65623683b00c0764ef00d05fa397 Mon Sep 17 00:00:00 2001 From: Alexandru Croitor Date: Wed, 31 Jan 2018 16:46:53 +0100 Subject: Improve documentation about OpenSSL Task-number: PYSIDE-599 Change-Id: Iea11cca0c5de0aec82ce504ce8ac14d9778c08dd Reviewed-by: Friedemann Kleint --- setup.py | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) (limited to 'setup.py') diff --git a/setup.py b/setup.py index 57214685d..767a59ce5 100644 --- a/setup.py +++ b/setup.py @@ -41,10 +41,10 @@ from __future__ import print_function """This is a distutils setup-script for the PySide2 project -To build the PySide2, simply execute: - python setup.py build --qmake= [--cmake=] [--openssl=] +To build PySide2 simply execute: + python setup.py build --qmake= [--cmake=] [only Windows --openssl=] or - python setup.py install --qmake= [--cmake=] [--openssl=] + python setup.py install --qmake= [--cmake=] [only Windows --openssl=] to build and install into your current Python installation. On Linux and macOS you can use option --standalone, to embed Qt libraries into the PySide2 package. @@ -58,10 +58,10 @@ option is not specified. You can use option --only-package, if you want to create more binary packages (bdist_wheel, bdist_egg, ...) without rebuilding entire PySide2 every time: # First time we create bdist_wheel with full PySide2 build - python setup.py bdist_wheel --qmake=c:\Qt\4.8.5\bin\qmake.exe --cmake=c:\tools\cmake\bin\cmake.exe --openssl=c:\libs\OpenSSL32bit\bin + python setup.py bdist_wheel --qmake=c:\Qt\5.6\bin\qmake.exe --cmake=c:\tools\cmake\bin\cmake.exe --openssl=c:\libs\OpenSSL32bit\bin # Then we create bdist_egg reusing PySide2 build with option --only-package - python setup.py bdist_egg --only-package --qmake=c:\Qt\4.8.5\bin\qmake.exe --cmake=c:\tools\cmake\bin\cmake.exe --opnessl=c:\libs\OpenSSL32bit\bin + python setup.py bdist_egg --only-package --qmake=c:\Qt\5.6\bin\qmake.exe --cmake=c:\tools\cmake\bin\cmake.exe --opnessl=c:\libs\OpenSSL32bit\bin You can use the option --qt-conf-prefix to pass a path relative to the PySide2 installed package, which will be embedded into an auto-generated qt.conf registered in the Qt resource system. This @@ -87,8 +87,21 @@ REQUIREMENTS: - Qt: 5.5 and 5.6 are supported. Specify the path to qmake with --qmake option or add qmake to the system path. OPTIONAL: -OpenSSL: You can specify the location of OpenSSL DLLs with option --opnessl=. - You can download OpenSSL for windows here: http://slproweb.com/products/Win32OpenSSL.html +OpenSSL: + Specifying the --openssl option is only required on Windows. It is a no-op for other platforms. + You can specify the location of OpenSSL DLLs with option --openssl=. + You can download OpenSSL for Windows here: http://slproweb.com/products/Win32OpenSSL.html + + Official Qt packages do not link to the SSL library directly, but rather try to find the library + at runtime. + + On Windows, official Qt builds will try to pick up OpenSSL libraries at application path, + system registry, or in the PATH environment variable. + On macOS, official Qt builds use SecureTransport (provided by OS) instead of OpenSSL. + On Linux, official Qt builds will try to pick up the system OpenSSL library. + + Note: this means that Qt packages that directly link to the OpenSSL shared libraries, are not + currently compatible with standalone PySide2 packages. OS X SDK: You can specify which OS X SDK should be used for compilation with the option --osx-sysroot=. For e.g. "--osx-sysroot=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.11.sdk/". @@ -768,7 +781,8 @@ class pyside_build(_build): log.info("Qt docs: %s" % self.qtinfo.docs_dir) log.info("Qt plugins: %s" % self.qtinfo.plugins_dir) log.info("-" * 3) - log.info("OpenSSL libs: %s" % OPTION_OPENSSL) + if sys.platform == 'win32': + log.info("OpenSSL dll directory: %s" % OPTION_OPENSSL) log.info("=" * 30) # Prepare folders -- cgit v1.2.3