# HG changeset patch # User Mike Becker # Date 1739221179 -3600 # Node ID 3ce4a58a3eeaa99eee1b529e116fa20698a72711 # Parent 453a45647a32d01ec625c63fb1105df599a6c700 update install instructions with instructions for windows DLL relates to #451 relates to #582 diff -r 453a45647a32 -r 3ce4a58a3eea docs/Writerside/topics/install.md --- a/docs/Writerside/topics/install.md Sun Feb 09 22:06:00 2025 +0100 +++ b/docs/Writerside/topics/install.md Mon Feb 10 21:59:39 2025 +0100 @@ -11,8 +11,8 @@ -Download the latest source archive from Source Forge -and extract it somewhere on your machine. +Download the latest source archive from +Source Forge and extract it somewhere on your machine. You can also use the command line to do this. wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz @@ -37,8 +37,8 @@ -Download the latest source archive from Source Forge -and extract it somewhere on your machine. +Download the latest source archive from +Source Forge and extract it somewhere on your machine. Navigate to the folder named msvc in the extracted directory structure. @@ -46,7 +46,14 @@ Open the contained ucx.sln in Visual Studio and build the solution. + +The libucx project in the solution will produce a libucx.lib that can be used for static linking +and the libucx_dll project will produce a libucx.dll and a libucx.dll.lib import lib for dynamic linking. + + +For native Windows projects it is recommended to statically link UCX. + @@ -77,6 +84,21 @@ + + CX_WINDLL + + Define this macro during compilation of the project that is using + UCX as a Windows DLL to import the symbols. + In general it is recommended to use UCX as a static library under Windows, though. + + + + CX_WINDLL_EXPORT + + Define this macro during compilation of UCX to export symbols for a Windows DLL. + The Visual Studio Solution does that automatically. + + ### Small Buffer Optimizations