From 02a1aca631c5db4f46590ba86615f04e5df531af Mon Sep 17 00:00:00 2001 From: Guenter Obiltschnig Date: Fri, 10 Nov 2017 13:12:12 +0100 Subject: [PATCH] doc fixes --- doc/00200-GettingStarted.page | 42 +++++++++++++++-------------------- doc/99100-ReleaseNotes.page | 2 +- release/script/mkdoc | 9 +------- 3 files changed, 20 insertions(+), 33 deletions(-) diff --git a/doc/00200-GettingStarted.page b/doc/00200-GettingStarted.page index 1a42681b4..db788be0f 100644 --- a/doc/00200-GettingStarted.page +++ b/doc/00200-GettingStarted.page @@ -126,7 +126,7 @@ OpenSSL yourself -- a binary distribution is fine. On macOS, it's recommended to install OpenSSL via Homebrew. $ brew install openssl ---- +---- <*Windows*> @@ -138,14 +138,13 @@ On Windows, there are three options: - Use a third-party pre-built OpenSSL -POCO pre-built OpenSSL binaries +<*POCO pre-built OpenSSL binaries*> -OpenSSL binaries (version 1.1.0) built with VS 2013 are available for download at: - -https://github.com/pocoproject/openssl/tree/master/VS_120 +OpenSSL binaries (version 1.1.0) built with Visual Studio 2013 are available for +[[https://github.com/pocoproject/openssl/tree/master/VS_120 download]]. In case you are using pre-built binaries, please make sure to copy the -entire directory to C:\%POCO_BASE%\openssl\ +entire directory to <*C:\%POCO_BASE%\openssl\*>. Or, %POCO_BASE%\openssl directory can be deleted and openssl repository cloned: @@ -154,20 +153,17 @@ repository cloned: $ rmdir /s /q openssl $ git clone https://github.com/pocoproject/openssl -All libraries are located in their proper folders (eg. win64/bin/debug/), -and all are named identically (libcrypto and libssl). +All libraries are located in their proper folders (eg. <*win64/bin/debug/*>), +and all are named identically (<*libcrypto*> and <*libssl*>). -Build OpenSSL using scripts from POCO distribution package +<*Build OpenSSL using scripts from POCO distribution package*> Alternatively, if you choose to build your own OpenSSL, POCO C++ Libraries distribution package comes with scripts to build OpenSSL on Windows operating -system. +system. This requires Windows PowerShell. -Prerequisites - - Powershell - -Usage +Usage: C:\%POCO_BASE%\openssl\build.ps1 [-openssl_release 1.0.0 | 1.1.0] [-vs_version 150 | 140 | 120 | 110 | 100 | 90] @@ -176,21 +172,19 @@ Usage [-library shared | static] ---- -Example - -Building OpenSSL 1.1.0, DLL release build for x64 with VS 2013: +Example: Building OpenSSL 1.1.0, DLL release build for x64 with Visual Studio 2013: C:\%POCO_BASE%\openssl\build.ps1 -openssl_release 1.1.0 -vs_version 120 -config release -platform x64 -library shared ---- The above command will download all the necessary packages (perl, nasm, etc) -and buil OpenSSL in C:\%POCO_BASE%\openssl\VS_120 directory; the built OpenSSL -binaries can be linked from EXEs and DLLs built with VS 2008-2017. +and buil OpenSSL in <*C:\%POCO_BASE%\openssl\VS_120*> directory; the built OpenSSL +binaries can be linked from EXEs and DLLs built with Visual Studio 2008 to 2017. Pre-generated POCO Visual Studio projects are configured to use headers and -libraries from VS_120 directory. +libraries from <*VS_120*> directory. -Use a third-party pre-built OpenSSL +<*Use a third-party pre-built OpenSSL*> Yet another way to install OpenSSL on Windows is to use a binary (prebuild) release, for example the one from Shining Light @@ -203,11 +197,11 @@ have to edit the project settings if the names of the OpenSSL libraries from your build differ from the names used in the project files. NOTE: To disable internal automatic linking of supplied binaries in pre-generated -POCO VS projects, define POCO_EXTERNAL_OPENSSL in your build environment. +POCO Visual Studio projects, define <[POCO_EXTERNAL_OPENSSL]> in your build environment. Alternatively, you can either rename your binaries, or edit the -%POCO_BASE%\Crypto\include\Poco\Crypto\Crypto.h file if the names of the +<*%POCO_BASE%\Crypto\include\Poco\Crypto\Crypto.h*> file if the names of the OpenSSL libraries from your build differ from the names used thereof -(look for "#pragma comment" lines in Crypto.h). +(look for "#pragma comment" lines in <*Crypto.h*>). !ODBC diff --git a/doc/99100-ReleaseNotes.page b/doc/99100-ReleaseNotes.page index 438ac5f84..d73c811ac 100644 --- a/doc/99100-ReleaseNotes.page +++ b/doc/99100-ReleaseNotes.page @@ -60,7 +60,7 @@ AAAIntroduction ([[https://github.com/pocoproject/openssl/archive/develop.zip Zip archive]]). You can also provide your own build of OpenSSL, by specifying the appropriate header and library search paths in the Visual Studio project files. Through the - <*Poco/Crypto/Crypto.h> and <*Poco/Net/NetSSL.h*> headers, the <*libcrypto.lib*> + <*Poco/Crypto/Crypto.h*> and <*Poco/Net/NetSSL.h*> headers, the <*libcrypto.lib*> and <*libssl.lib*> libraries will be automatically linked. If you don't want this, build Crypto and NetSSL_OpenSSL with the <[POCO_EXTERNAL_OPENSSL]> macro defined. diff --git a/release/script/mkdoc b/release/script/mkdoc index 98c15b7f2..5d31db39b 100755 --- a/release/script/mkdoc +++ b/release/script/mkdoc @@ -25,12 +25,6 @@ case `uname` in ;; esac - -if [ $osname = "Darwin" ] ; then - archpath=`dirname stage/tools/PocoDoc/bin/Darwin/*/PocoDoc` - osarch=`basename $archpath` -fi - spec="" docConfig=$POCO_BASE/PocoDoc/cfg/mkdoc-poco.xml while [ "$1" != "" ] ; @@ -92,7 +86,7 @@ mkrelease -o $tools $version CppParser PocoDoc cd $tools ./configure --no-tests --no-samples --no-prefix -make -s -j8 +make -s -j8 if [ $osname = "CYGWIN" ] ; then find $tools -type f -name "cyg*$libversion.dll" > $TMP/dlls @@ -107,7 +101,6 @@ if [ $osname = "CYGWIN" ] ; then export PATH=$tools/lib/$osname/$osarch:$PATH fi - export PATH=$tools/PocoDoc/bin/$osname/$osarch:$PATH echo PATH=$PATH