Project

General

Profile

Preparing a Windows machine for Bilder » History » Version 145

John Cary, 12/10/2019 02:20 AM

1 1 Redmine Admin
# Preparing a Windows machine for Bilder (64-bit only)
2
3 39 Ted Sume
For building on Windows 10 in Ubuntu, follow the Linux Bilder setup instructions. 
4
5 112 David Alexander
_Warning:_ In following the directions below, pre-defined env variables like CL, PETSC_DIR, PETSC_ARCH, and others will cause problems.  For example, one user had CL=/nologo which prevented the version and other info from being printed and caused bilder to fail.
6 1 Redmine Admin
7
# Basic Windows Configuration
8
9 112 David Alexander
## UAC
10 1 Redmine Admin
11 112 David Alexander
Windows 7/2008: For 64-bit systems, 64-bit applications are stored in C:\Program Files and 32-bit applications are stored in C:\Program Files (x86). UserAccountControlSettings can be fine-tuned (see Control-Panel, System and Security, Action Center). Set Control Setting to the lowest setting (never notify) to avoid unwanted dialog boxes. This requires a reboot to take effect! The UAC Settings must be adjusted to "never notify" (this action is needed to make symbolic links during bilder runs and building Atlas). \
12 1 Redmine Admin
13 112 David Alexander
## Editing your system path on Windows
14
15 1 Redmine Admin
From the Start menu, right click on My Computer and choose Properties. Choose the Advanced Tab, and click the Environment Variables button towards the bottom of the dialog. In System Variables, highlight Path and click Edit. This is where you make changes to your system path.
16
17 112 David Alexander
## If your machine is on a Windows Domain (as compared to a WORKGROUP), then ensure that Windows knows its domainname
18 1 Redmine Admin
19 96 David Alexander
If your machine is on a Windows Domain, then Bilder can set a common variable that makes sense in that Domain. If you are not on a Windows Domain, then Bilder will still work fine (except for maybe emailing). To ensure Windows knows its domainname to the following.
20 89 David Alexander
21 1 Redmine Admin
* From a command prompt, type the command: 
22
23
~~~~~~
24
ipconfig /all
25
~~~~~~
26
27 96 David Alexander
Look for the value of the "Primary Dns Suffix" field, which should be your domain name (i.e. txcorp.com).
28 1 Redmine Admin
29
* If cygwin is already installed,
30
31
~~~~~~
32
ipconfig /all | grep -i "Primary Dns Suffix" | sed -e 's/^.*: //'
33
~~~~~~
34
35 89 David Alexander
should return the domainname. 
36 1 Redmine Admin
37
* For Windows 7/Windows 2008 machines that are not a member of the Windows Domain, Active Directory, do the following:
38
    1. Right click on My Computer, select properties
39
    2. Click on Advanced system settings
40
    3. Select the computer name tab
41
    4. Click the change button
42
    5. Click the more button
43
    6. Enter the Primary DNS suffix. i.e. txcorp.com 
44
45 112 David Alexander
## Create initial directories
46 1 Redmine Admin
47
* Create the folder C:\\bin (if not already present).
48
* Add or move C:\\bin to the front of your system path.
49
50 113 David Alexander
# Software "Required" for Bilder
51 1 Redmine Admin
52 74 David Alexander
What is absolutely required for Bilder depends on what you are trying to build. For example, if you are **only building user documentation**, then you only need
53 37 John Cary
54 74 David Alexander
* Blat (for emailing yourself)
55 36 John Cary
* Cygwin (for bash shell)
56 1 Redmine Admin
* CMake from an installer
57 38 John Cary
* Python from an installer
58
* Latex (MikTek below)
59 1 Redmine Admin
* Visual Studio Express (for nmake)
60 36 John Cary
61 1 Redmine Admin
and then you can add the arguments,  -W python,cmake, and your installed Python and CMake will be used if your path is correct.
62
63 144 David Alexander
Since bilder uses the C++17 conformance flags, we require:
64 82 John Cary
65 144 David Alexander
* Visual Studio 2017 version 15.7 or higher (As of Oct 2019 the latest upgrade version is 15.9.17, which is fine)
66 83 John Cary
* Windows 10 or Windows 10 SDK
67
68 74 David Alexander
Below is a list of the Tools and Libraries that are most often needed.
69
70
# Tools (Required for most common builds within Bilder)
71
72 1 Redmine Admin
## Blat
73
74 74 David Alexander
*Blat is a sendmail client for Windows needed to send emails.*
75 1 Redmine Admin
76
* Download Blat from [The Blat SourceForge](http://sourceforge.net/projects/blat) Site and extract all files. As of 07/18/2013, this is version 311.
77
* Extract the blat311 folder into C:\\bin.
78
* Copy the C:\bin\blat311\full\blat.{exe,dll} to C:\bin\blat.{exe,dll}
79
* Execute the following command in a cygwin terminal
80
81
~~~~~~
82
    blat -install mail.txcorp.com <username>@txcorp.com
83
~~~~~~
84
85
## CMake
86
87 74 David Alexander
*CMake is a cross-platform build system needed to configure many of necessary packages.*
88 1 Redmine Admin
89
* Install [CMake (a 32-bit application)](http://www.cmake.org/files/).
90 136 Nathan Neri
  * Version 3.14 is what we use now.  Picking a later version is better because it will allow bilder to build future versions of cmake.
91 26 John Cary
  * Add the CMake path to the front of the system path! (Needed to build newer 64 bit versions through Bilder)
92 1 Redmine Admin
  * When this step is complete, make sure the newest CMake is the only one in your system path.
93
94 10 Redmine Admin
## CYGWIN
95 1 Redmine Admin
96 74 David Alexander
*Cygwin is a Unix shell program for Windows and is needed to run the bash code of Bilder.*
97
98 1 Redmine Admin
### Gotchas (in advance)
99
100
* Do not install Cygwin's MinGW. Those are installed in a separate area to reduce conflicts.
101
* Do not install Cygwin's rc, or you may get a weird error (/focmTryCompileExec.exe.embed.manifest.res: No such file or directory) about cl being invalid.  This can be seen by the output of 'which rc'.
102
* Do not install Cygwin's mt.  If 'which mt' returns /bin/mt or /usr/bin/mt, then move this aside too.
103 11 Redmine Admin
* If 'which link' returns /usr/bin/link, then move this aside (mv /usr/bin/link.exe /usr/bin/linkoff.exe) so that it is not picked up to replace the Visual Studio link.  (This is where we could define BILDER_LINK.)
104 1 Redmine Admin
* Make sure that 'which find' returns the cygwin version (/usr/bin/find), not the Windows version.
105
* Make sure 'which cmd' returns the Windows version. If not, check that your bash_profile has not made an error in setting your path.
106
* If you get an error like "ValueError: Symbol table not found" when building numpy, you are somehow using a 32-bit version of objdump.  Disable the 32-bit version.
107
108
### Updating Cygwin
109
110
* Be sure to select the version of subversion that is compatible with any other sister machines being run through jenkins.  They must all use the same version of svn, which must be the same version chosen in Jenkins.
111
* If you have moved aside any of the interfering commands (e.g. link, mt, rc) in the past and have recently updated cygwin or Windows, then do the 'which' checks again.
112
* Recreate the /etc/passwd and /etc/group file again using the mkpasswd and mkgroup commands described in the Configuring Cygwin section.
113
* Install Cygwin from [here](http://cygwin.com/install.html). There are now separate installers for 64 bit (setup-x86_64.exe ) and 32 bit (setup-x86.exe).
114
* Upon running setup-*.exe, select the packages:
115 3 Redmine Admin
  * Base -> util-linux
116
  * Devel -> bison
117
  * Devel -> flex
118 4 Redmine Admin
  * Devel -> gcc-g++ and gcc-fortran (4.9.3 does not compile sqlite, so choose 4.9.2)
119 3 Redmine Admin
  * Devel -> git
120
  * Devel -> make
121
  * Devel -> mercurial
122 1 Redmine Admin
  * Devel -> patch
123 27 John Cary
  * Devel -> subversion (If this machine will be a Jenkins slave, the version of subversion that is consistent with the Jenkins master's svnkit should be chosen. The latest version supported by svnkit is 1.8.14 at the time, Dec. 31, 2016, of this writing.)
124 3 Redmine Admin
  * Editors -> vim and emacs (and alternate editors of choice)
125
  * Math -> bc
126
  * Net -> openssh
127 25 Matt Copper
  * Net -> curl
128 3 Redmine Admin
  * Python -> python (see note below)
129
  * Shells -> mintty
130
  * Utils -> diffutils
131
  * Utils -> dos2unix
132
  * Web -> wget
133 1 Redmine Admin
134
* Do NOT install any of the mingw packages.  If used, they must be installed separately to overcome path issues.  (NumPy will not accept the different, distinguishing name for mingw's gcc).
135
136
* Note: PATH should be set such that the Windows python is found before the cygwin python. We need the cygwin python to build PETSc. Once PETSc is cmaked, this requirement will go away.
137
* Note: mkshortcut.exe in cygutils 1.4.10-2 is broken, but as of (July 18, 2013 with cygutils version 1.4.12 this is fixed).  If the version of mkshortcut.exe that is installed when you run setup.exe doesn't work (i.e. mkshortcut -h segfaults), then go bach to cygwin setup and update your cygutils.
138
139
### Setting Cygwin Disk Mounts
140
141
* Create the directory winsame at the top level of both the Cygwin and Windows file systems. You must always work in this directory.  This is critical for getting the ATLAS linear algebra libraries to build. Do this via:
142
143
~~~~~~
144
mkdir /cygdrive/c/winsame
145
mkdir /winsame
146
mount C:/winsame /winsame
147
~~~~~~
148
149
To make this permanent, put
150
151
~~~~~~
152
C:/winsame /winsame ntfs binary 0 0
153
~~~~~~
154
155
as one line in /etc/fstab.
156
157
On Windows-64, additionally put
158
159
~~~~~~
160
C:/Program\040Files\040(x86) /ProgramFilesX86 ntfs binary 0 0
161
~~~~~~
162
163
as one line in /etc/fstab.  This allows one to construct a valid path with no parentheses as needed for ATLAS.
164
165
### Configuring Cygwin
166
167 6 Redmine Admin
* Use a "Cygwin64 Terminal" from basic cygwin installation above to perform all subsequent bash tasks
168 1 Redmine Admin
169
* If bilderizing a domain machine, create an /etc/passwd file with the following command
170
171
~~~~~~
172
mkpasswd -l -d -p /winsame > /etc/passwd
173
~~~~~~
174
175 71 Tech-X Corporation
* Add a single domain user to an already created /etc/password:
176
177
~~~~~~
178
mkpasswd -l -d -u {username} -p /winsame >> /etc/passwd
179
~~~~~~
180
181 1 Redmine Admin
* If bilderizing a non-domain machine, create an /etc/passwd file with the following command
182
183
~~~~~~
184
mkpasswd -l -p /winsame > /etc/passwd
185
~~~~~~
186
187
* If bilderizing a domain machine, create an /etc/group file with the following command
188
189
~~~~~~
190
mkgroup -l -d > /etc/group
191
~~~~~~
192
193
* If bilderizing a non-domain machine, create an /etc/group file with the following command
194
195
~~~~~~
196
mkgroup -l > /etc/group
197
~~~~~~
198
199
* Close the terminal and open a new one. You should see that the 'pwd' command shows that you are in a new home area directory: /winsame/<username>. Copy bash profile files from /home to /winsame and delete the previous home area for each user with the commands:
200
201
~~~~~~
202
cp /home/<username>/.* /winsame/<username>/
203
rm -rf /home/<username>
204
~~~~~~
205 52 John Cary
206 1 Redmine Admin
## Dependency Walker
207 52 John Cary
208 74 David Alexander
*Dependency Walker shows the DLL's that an executable depends on and is needed to find and copy-in DLLs to a final distribution.*
209 52 John Cary
210 1 Redmine Admin
__Make sure you download and install the correct version of dependencywalker for your machine (x86 for x86 machines, x64 for 64bit machines, etc).__
211 5 Redmine Admin
212 52 John Cary
Install [Dependency Walker](http://www.dependencywalker.com/) into C:\\bin.
213 1 Redmine Admin
214
## JOM
215
216 74 David Alexander
*JOM is an nmake wrapper needed to give  the -j flag capability of Unix make for faster compilation.*
217 1 Redmine Admin
218
* Create the folder C:\bin (if not already present).
219
* Add C:\bin to your system path (if not already there).
220
* Download jom.zip from [the Qt Project](https://wiki.qt.io/Jom).
221
* Extract the contents of jom.zip
222
* Move/copy jom.exe to C:\bin (you then can delete the remainder of the contents or keep for historical reasons).
223
224
## LaTeX
225
226 74 David Alexander
*LaTeX is a typesetting tool needed for building PDF files for user documentation.*
227 1 Redmine Admin
228 123 Benjamin Cowan
* Install [Doxygen](http://www.doxygen.nl/).  Choose "Letter" for paper size and "Yes" for "Install missing packages on-the-fly".
229 92 John Cary
* Install Basic MikTeX from [MikTeX](http://miktex.org/). Use the MikTeX Package Manager to install the packages noted at
230
[[LaTeX packages needed by Bilder]]
231 124 Benjamin Cowan
* Install [ghostscript](https://www.ghostscript.com/download/gsdnld.html).
232 1 Redmine Admin
233
234
## MPI
235
236 74 David Alexander
*MPI is a message passing interface for parallel code that is needed for some computation engines.*
237
238 98 Ted Sume
Download Microsoft MPI v8.1.1 from:
239 1 Redmine Admin
240 98 Ted Sume
https://www.microsoft.com/en-us/download/details.aspx?id=55991
241 1 Redmine Admin
242 93 John Cary
The binaries (e.g., mpiexec) are obtained by installing msmpisetup.exe.
243 1 Redmine Admin
244 94 John Cary
The libraries (msmpi.lib) are obtained by installing msmpisdk.msi.
245 1 Redmine Admin
246 93 John Cary
The installers will put mpiexec in your path and define the environment variables,
247
248
MSMPI_INC
249
MSMPI_BIN
250
MSMPI_LIB32
251
MSMPI_LIB64
252
253
which are used by CMake, e.g., to find the needed components of MSMPI.
254 1 Redmine Admin
255 85 John Cary
## Perl (required to build OpenSSL, therefore CMake)
256 1 Redmine Admin
257 74 David Alexander
*Perl is a programming language needed by some packages such as Qt*
258 1 Redmine Admin
259
* Download and install [ActiveState Perl](http://www.activestate.com/activeperl/downloads).
260
261
## Python
262
263 74 David Alexander
*Python is a programming language needed by many packages. Namely, any Python module needs Python to be installed.*
264
265 14 Redmine Admin
* As of VS12, bilder builds Python from a checkout of a git repo and no longer needs to be installed by hand. No PATH changes are needed either.
266 1 Redmine Admin
267 107 John Cary
## RCEDIT
268
269
* RCEDIT is a program that allows one to change the icon of an executable after its creation.  It can be obtained from https://github.com/electron/rcedit/releases, and it should be installed in C:\bin.
270
271 85 John Cary
## Ruby (required to build Qt5)
272
273
* Ruby, http://rubyinstaller.org/, must be installed first.
274
275 1 Redmine Admin
## Subversion
276
277 74 David Alexander
* Subversion is a revision control tool needed by bilder, for example, to know when packages are out of date.*
278 1 Redmine Admin
279 108 Benjamin Cowan
* Install [TortoiseSVN](https://tortoisesvn.net/downloads.html) with its command line tools.
280 1 Redmine Admin
281 89 David Alexander
* With this, you will have two versions of svn on your machine. One is in `/usr/bin` under cygwin, and it is used for direct invocation at the bash command-line. The other is in `\Program Files`, and it is needed for getting repo versions when Bilder is invoked through Jenkins.  As of this writing, 1.9 is recommended (1.8 will also work, but lower versions will not).
282 33 Tech-X Corporation
283 1 Redmine Admin
~~~~~~
284
$ where svn
285 84 John Cary
C:\cygwin64\bin\svn.exe
286
C:\PROGRAM FILES\TORTOISESVN\bin\svn.exe
287
$ /usr/bin/svn --version | head -1
288
svn, version 1.9.7 (r1800392)
289
$ /cygdrive/c/Program\ Files/TortoiseSVN/bin/svn --version | head -n 1
290
svn, version 1.9.7 (r1800392)
291 15 Redmine Admin
~~~~~~
292 1 Redmine Admin
293
## Visual Studio
294 15 Redmine Admin
295 74 David Alexander
*Visual Studio contains the Microsoft command-line compiler (cl) used by packages with C/C++ code.* 
296
297 1 Redmine Admin
* Bilder works with VS12 (Visual Studio 2013). Since code is moving to C++11 standards, VS12 is required. We recommend you remove older versions of VS such as VS10 and VS9.
298
299
    * VS12: Visual Studio 2013 Community Edition from Microsoft [VS12 Download Site](https://www.visualstudio.com/en-US/products/visual-studio-community-vs)
300
301
* Install the latest update for Visual Studio. Open Visual Studio application. Going to Help -> About Microsoft Visual Studio, should show you the update version installed. As of July 2015 it is as Update 5. To update go to [Visual Studio Update Download](http://www.microsoft.com/en-us/download/details.aspx?id=48129).
302
303
* Ensure that Visual Studio is not in the system path. (Bilder adds this as needed.)
304 7 Redmine Admin
305 26 John Cary
### Compatibility with Python
306 7 Redmine Admin
307 1 Redmine Admin
* Python is built by Bilder.
308
309 78 Ted Sume
### Compatibility with CUDA 9.1 
310
* CUDA version 9.1 requires the use of Microsoft Visual Studio 2017 v15.4.5. See [VS2017 Prior Release Download Site](https://www.visualstudio.com/en-us/productinfo/installing-an-earlier-release-of-vs2017) for instructions on downloading a specific Release.
311 74 David Alexander
312 141 David Alexander
## LLVM-Clang
313
314 145 John Cary
You may want LLVM-Clang to be able to have OpenMP on Windows.  If that is not needed, you can skip it. Otherwise you can either install an LLVM-Clang installer or build LLVM-clang from source.
315
316
### Installing LLVM-Clang from a binary installer (easiest way)
317
318
Download the Windows (64-bit) installer from http://releases.llvm.org/download.html, and proceed with the installation..
319
320
### Building LLVM-Clang from source
321
322
We are currently using the `<Release Branch Name>=release/8.x branch` which is at `<Version>=8.0.1` as of September 2019, available from https://github.com/llvm/llvm-project .  Check out the llvm-project via GIT:
323 141 David Alexander
324
~~~~~~~~~~
325
cd /winsame/builds-llvm_vs2017 # Create directory if it doesn't exist already.
326
git clone -b <Release Branch Name> https://github.com/llvm/llvm-project.git llvm-<Version>
327
~~~~~~~~~~
328
329
To configure and build (in a cygwin terminal where you have sourced a machines file, e.g. cygwin.vs2017, from a checkout of bilder):
330
331
~~~~~~~~~~
332
cd /winsame/builds-llvm_vs2017/llvm-<Version>
333
mkdir build
334
cd build
335
cmake \
336
  -DCMAKE_INSTALL_PREFIX:PATH=D:/winsame/builds-llvm_vs2017/llvm-<Version>/install \
337
  -DCMAKE_BUILD_TYPE:STRING=Release \
338
  -DCMAKE_C_COMPILER:FILEPATH='<Windows path to cl.exe>' \
339
  -DCMAKE_CXX_COMPILER:FILEPATH='<Windows path to cl.exe>' \
340
  -DCMAKE_C_FLAGS:STRING='/W3' \
341
  -DCMAKE_CXX_FLAGS:STRING='/W3 /GR /EHsc' \
342
  -DLLVM_ENABLE_PROJECTS="clang;openmp" -DLLVM_ENABLE_RTTI:BOOL=ON -DLLVM_ENABLE_EH:BOOL=ON \
343
  -G 'NMake Makefiles JOM' \
344
  ../llvm
345
jom
346
jom install
347
~~~~~~~~~~
348
349
Bilder will look for /winsame/builds-llvm_vs2017/llvm-current, so we set a link to the version we want to use (Bilder will also look in $LLVM_DIR and in your installation directory, for checking builds with multiple versions):
350
351
~~~~~~~~~
352
cd /winsame/builds-llvm_vs2017
353
ln -s llvm-<Version>/install llvm-current
354
~~~~~~~~~
355
356 1 Redmine Admin
# Libraries (Required for most builds with Bilder)
357
358
## OpenSSL
359
360 85 John Cary
*OpenSSL is a security library needed by Python to build the SSL module, by cmake, libssh, and by Qt.*
361
*We no longer install OpenSSL on Windows, as Bilder builds it to be consistent with the compiler in use."
362 1 Redmine Admin
363 85 John Cary
### Legacy instructions.
364
365 1 Redmine Admin
* Download from http://slproweb.com/products/Win32OpenSSL.html
366 75 John Cary
* Choose the Win64 OpenSSL v1.0.2n  (not Light) on 64bit or the Win32 OpenSSL v1.0.2n on 32bit windows.
367 76 John Cary
* **The 1.1 series DOES NOT WORK with either libssh or Qt.**
368 1 Redmine Admin
* You may have to install Visual C++ Redistributables if the installer complains.
369
* During the installation, select "Copy OpenSSL DLLs to: The OpenSSL binaries (/bin) directory"
370
* After the installation on 64bit windows, goto C:\Windows\System32 and prepend libssl32.dll, libeay32.dll, and ssleay32.dll with an "OFF", if these files exist.  This and the next step are required so that dependency walker finds the SSL libs from the OpenSSL distro instead of the ones in C:\Windows\System32.
371
* Add C:\OpenSSL-Win64 (in some cases, we have seen that C:\OpenSSL-Win64\bin should be added instead) or the directory where you installed OpenSSL to the beginning of the system path. In particular, it needs to be in front of the CollabNet path and the Intel client path, because both contain libeay32.dll. A which for the libeay32.dll should give this installed version. For example:
372
373 30 John Cary
~~~~~~
374
which libeay32.dll
375 1 Redmine Admin
/cygdrive/c/OpenSSL-Win64/bin/libeay32.dll
376 73 Tech-X Corporation
~~~~~~
377 30 John Cary
378 1 Redmine Admin
* If built software has unexplained crashes, recheck the above command results.
379
380 109 Tech-X Corporation
381
# Composer-related Libraries (only needed for building ComposerToolkit, can be skipped for documentation builds)
382
383 125 Nathan Neri
## Git LFS
384
385
*Git LFS is a git extension for repos with large files - needed to use git for VisIt repos*
386
387
Download and run the installer: https://git-lfs.github.com/
388
389 130 Nathan Neri
You can adjust the configuration by running (from Cygwin) `git lfs install --force --skip-smudge` with new configuration options.
390 125 Nathan Neri
391 127 Nathan Neri
To ensure that git will find git lfs, add a symbolic link from git's exec path to the location of the git-lfs executable.
392
393
~~~~~~
394
LINK_TO_PATH=`which git-lfs.exe`
395
LINK_FROM_PATH=`git --exec-path`
396
cd $LINK_FROM_PATH
397
ln -s "$LINK_TO_PATH" git-lfs.exe
398
~~~~~~
399
400 74 David Alexander
## Qt
401 1 Redmine Admin
402 74 David Alexander
*Qt is a cross-platform GUI library needed to build packages that have Qt-based user interfaces.*
403
404 142 David Alexander
Qt5 is the recommended version (the previous version, Qt4, instructions are also here too until Qt5 is solid).
405 1 Redmine Admin
406 142 David Alexander
### Installing Qt5
407
408
These instructions are how to install the pre-built version of Qt 5 (version 5.12.5).  You can skip creating the Qt account.
409
410
* Get Qt-5.12.5 from http://download.qt.io/official_releases/qt/5.12/5.12.5/qt-opensource-windows-x86-5.12.5.exe
411
* Run this program, selecting `<DRIVE>\winsame\winqt\5.12.5` as your installation directory, where DRIVE is the drive you have winsame on (e.g. D: or C:). (Bilder will find Qt5 if it is here)
412
* Select the following components:
413
  * MSVC 2017 64-bit
414
  * Sources
415
  * Qt WebEngine
416
* Optionally, under Tools select:
417
  * Qt Creator 4.8.1 CDB Debugger Support
418
  * Qt Creator 4.8.1 is selected by default
419
* Accept all remaining defaults unless otherwise preferred
420
421 143 David Alexander
### Building and Installing Qt4
422 74 David Alexander
423 41 John Cary
* Make sure no other Qt is in your system path.
424 114 Nathan Neri
* Get the Qt Libraries from http://download.qt.io/archive/qt/4.8/4.8.7/. Download qt-opensource-windows-x86-vs2010-4.8.7.exe. (The vs2010 in the name is irrelevant as we will build Qt using the source code in this download.)
425 118 Nathan Neri
* Run this program, selecting C:\winsame\builds-XX\winqt\4.8.7 as your installation directory, where XX is the machines file suffix you use (e.g. vs2017).
426 41 John Cary
* If 4.8.7, patch Qt by opening a Cygwin window:
427 1 Redmine Admin
428
~~~~~~
429
cd /winsame/builds-vs12/winqt/4.8.7
430 100 John Cary
~~~~~~
431
432 106 John Cary
To build with VS2017, you may need to patch.  For this you will need python with the patch module installed, which you can obtain by running composerall, e.g., with target, python.  Then do
433 100 John Cary
434
~~~~~~
435 119 Nathan Neri
/path/to/bilder/installed/python -m patch /path/to/bilder/patches/02-fix_build_with_msvc2015-45e8f4ee.diff
436 1 Redmine Admin
~~~~~~
437
438 74 David Alexander
#### Compiling Qt4
439 1 Redmine Admin
440
* The copy/paste-able commands below assume VS12.
441
442
In a Visual Studio x64 DOS window:
443
444
~~~~~~
445 116 Nathan Neri
set VER=2017
446
REM could be 12
447 120 Nathan Neri
set DRIVE=C:
448
REM or D:, if you're building there
449 1 Redmine Admin
set SFX=vs%VER%
450
REM or whatever machine suffix you will be building for, if using a combined compiler build
451
set QTVER=4.8.7
452 120 Nathan Neri
set INSTALL_DIR=%DRIVE%\winsame\builds-%SFX%\winqt\%QTVER%\%QTVER%\msvc%VER%_64
453 1 Redmine Admin
~~~~~~
454
455 103 John Cary
Modify the last line as needed, e.g., different drive or subdir.
456 1 Redmine Admin
457 106 John Cary
Set the platform args according to your compiler.
458 1 Redmine Admin
459 106 John Cary
For VS2013 (VS12).
460
461 101 John Cary
~~~~~~
462 106 John Cary
set PLATFORM_ARGS=-platform win32-msvc2013
463 101 John Cary
~~~~~~
464
465 106 John Cary
For VS2015 or VS2017:
466 101 John Cary
467
~~~~~~
468 106 John Cary
set PLATFORM_ARGS=-platform win32-msvc2015
469 101 John Cary
~~~~~~
470 1 Redmine Admin
471
Then
472
473
~~~~~~
474 120 Nathan Neri
%DRIVE%
475
cd %DRIVE%\winsame\builds-%SFX%\winqt\%QTVER%
476 116 Nathan Neri
configure.exe -prefix %INSTALL_DIR% -debug-and-release -opensource -confirm-license -fast -no-sql-db2 -no-sql-ibase -no-sql-mysql -no-sql-oci -no-sql-odbc -no-sql-psql -no-sql-sqlite -no-sql-sqlite2 -no-sql-tds -no-libtiff -webkit -declarative %PLATFORM_ARGS%
477 1 Redmine Admin
~~~~~~
478
479
In a bash window launched from the previous DOS window (try `C:\cygwin64\bin\mintty -`, note that the dash is important!), execute the following (changing vsver to your version)
480
481 106 John Cary
~~~~~~
482 99 John Cary
export VER=12 # or 2017
483
export SFX=vs${VER}
484 44 John Cary
cd /winsame/builds-${SFX}/winqt/4.8.7
485 115 John Cary
export INSTALL_DIR=/winsame/builds-${SFX}/winqt/4.8.7/4.8.7/msvc${VER}_64
486
mkdir -p ${INSTALL_DIR}
487 139 David Alexander
cp -R mkspecs ${INSTALL_DIR}
488 128 Nathan Neri
~~~~~~
489
490 137 David Alexander
Back in the Visual Studio x64 DOS window
491 128 Nathan Neri
492
~~~~~~
493
%DRIVE%
494
cd %DRIVE%\winsame\builds-%SFX%\winqt\4.8.7 
495 1 Redmine Admin
set PATH=%PATH%;%DRIVE%\winsame\builds-%SFX%\winqt\4.8.7\bin
496
nmake
497 128 Nathan Neri
REM Took 3.5 hours on a 2.3 GHz Core2 Duo with Solid State Drive
498
nmake install
499
REM Took 10 minutes on a 2.3 GHZ Core2 Duo with Solid State Drive
500
~~~~~~
501
502 1 Redmine Admin
* For CMake to find Qt, add INSTALL_DIR to your supra search path when configuring.
503
504 142 David Alexander
* If you want to use this qt outside of Bilder, add ${INSTALL_DIR}/bin to the system path variable.  This may not work if you have more than one Bilder run.
505
506 140 David Alexander
507
# Additional Useful Tools
508
509
## Notepad++
510
511
* (Optional) Notepad++ is a free source code editor that is a great tool for Windows.
512
* Download from http://notepad-plus-plus.org/
513
* Install and pin to your taskbar.
514 1 Redmine Admin
515 110 David Alexander
## Java
516
517
Java is needed for setting up the machine to be a Jenkins Slave.
518
519
* Download from https://www.java.com/en/download/  (Version 8 Update 181 has a Release date of July 17, 2018) 
520
* May get a message about the Java Plugin and Chrome. This does not affect the Jenkins slave service.
521 111 David Alexander
* Download the JNLP page from the Jenkins server site (link button with label "Launch agent from browser").
522
* Start a command prompt running as Administrator, then change to the Download directory and type "javaws slave-agent.jnlp" 
523 110 David Alexander
* Choose File -> "Install as a service" and follow the dialog messages.
524
525 1 Redmine Admin
# Experimental Tools and Libraries
526
527
These tools have not been fully vetted or built, so you need not do these.
528
529
## MinGW
530
531
See [[Installing MinGW]].
532
533
## ATLAS
534
535
See [[Installing ATLAS on Windows]].
536 8 Redmine Admin
537 131 John Cary
## OpenBLAS
538
539
See [[Installing OpenBlas on Windows]]
540
541 1 Redmine Admin
# Cygwin and Paths
542 8 Redmine Admin
543 1 Redmine Admin
(This section assumes the user is familiar with the relations between Cygwin and Windows paths.)
544
545
The path is critical for when there are conflicting executables.  This is the case for Subversion and OpenSSL.
546
547
The cygwin and Windows versions of svn are incompatible due to line endings, so care must be taken as to which is used at what time.
548
549
The path to cygwin's version of svn will be ahead of the Windows Subversion so as to allow users to checkout a project using /usr/bin/svn and never worry about the Windows version of svn.
550
551
The path to the installed OpenSSL needs to be in front of the path to Subversion because during the copying in of OpenSSL libraries depends needs to find the ones in the OpenSSL installation not the Subversion installation.
552
553
## Usage under Jenkins
554
555
Jenkins uses `svnkit`, which is compatible with the Windows version of Subversion of the same version number.  So for jenkins usage, one must have the same version of `svn` installed across all slaves, and when `Bilder` runs under Jenkins, it must be sure to use the Windows version of `svn`.  There are two methods for doing this.  First, `bilder/jenkins/jenkinsbild` defines the environment variables, `BILDER_SVN`, `BILDER_SVNDIR`, and `BLDR_SVNVERSION`, which hold the correct executables to be used by `Bilder`.  However, in the configuration of some packages, notably VisIT in `visit.sh`, the path is used to find `svn`, and this gives the wrong executable.  For these cases, the path is modified just before configuration.
556
557
558
## Summary
559
560
* Bilder moves `/usr/bin` to just after the Python path and therefore to before
561
  `/cygdrive/c/Windows/system32`.
562
* Put the Windows Subversion path behind the Python path (and so behind `/usr/bin`).
563
    - `/usr/bin` must be removed from the path when configuring some packages in order to get the correct subversion when building under Jenkins.
564
565
# Bilder machine files for cygwin
566
567
The Bilder machine file for cygwin and Visual Studio 2013 (VS12) is bilder/machines/cygwin.vs12. It is sourced by bilder using the -m option. It augments PATH and sets the values of the INCLUDE, LIB, and LIBPATH variables.
568
569
In case of problems, one should check that the values of these were set correctly. This is done by starting up the **Visual Studio Command Prompt**, then starting rxvt as noted above. The values for or additions to these variables should agree with how they are being set or modified by the cygwin machine files.
570
571
# Setup for making Installers
572
573
## Visual Studios Redistributables
574
575
Download vcredist_x64.exe (Visual C++ Redistributable Packages for Visual Studio 2013)
576
577
http://www.microsoft.com/en-gb/download/details.aspx?id=40784
578
579
Choose only vcredist_x64.exe executable from list. Put executable in C:\bin.
580
581
## Sign Tools
582
583
* The Microsoft Signtool comes with Visual Studio, however, one must install a code-signing certificate. This process is site-specific so please see your system administrator.
584
* Contrary to what signtool says, the capicom dll must be copied from C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin to C:\Windows\System32 and must be registered by typing the following at a Command Prompt run as Administrator: 
585
586
~~~~~~
587 74 David Alexander
cd C:\Windows\System32
588
REGSVR32 capicom.dll
589
~~~~~~
590
591
## NSIS
592
593
NSIS is a scriptable installer maker.
594 1 Redmine Admin
595
* Install NSIS from [NSIS Download Site](http://nsis.sourceforge.net/Download).
596 131 John Cary
  * For building CMake 64bit and if you are building the composers, you will need a generator for installer executables, which is NSIS (Nullsoft Scriptable Install System) a professional open source system to create Windows installers.
597
  * Version 2.46 is available as of Aug 21, 2011.
598 88 John Cary
* Add `C:\Program Files (x86)\NSIS\Bin` to your system path.
599 74 David Alexander
600
* Install NSIS Access Control Plugin from [Access Control Plugin Site](http://nsis.sourceforge.net/AccessControl_plug-in).
601
602
Copies directories and files into the NSIS installation as follows:
603
604
~~~~~~
605
AccessControl.zip\Contrib\AccessControl --> NSIS\Contrib\AccessControl
606
AccessControl.zip\Docs\AccessControl --> NSIS\Docs\AccessControl
607 1 Redmine Admin
AccessControl.zip\Plugins\AccessControl.dll --> NSIS\Plugins\x86-ansi\AccessControl.dll
608
AccessControl.zip\Unicode\Plugins\AccessControl.dll --> NSIS\Plugins\x86-unicode\AccessControl.dll
609
~~~~~~
610
611
# Notes For Development
612
613
[[Notes on debugging Windows executables]]
614
[[Notes on deleting directories and files owned by other users]]