Project

General

Profile

Preparing a Windows machine for Bilder » History » Version 168

Ted Sume, 02/21/2024 11:04 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 168 Ted Sume
User Account Control Settings can be fine-tuned (see Control-Panel -> System and Security -> Change User Account Control settings). 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 152 John Cary
## File Name too long
14
15
This can be a problem when cloning Trilinos.  To fix, see https://www.techinpost.com/the-file-name-too-long/.  In essence, use regedit to go to
16
```
17
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem
18
```
19
where you can set LongPathsEnabled to 1, then reboot.
20
21 112 David Alexander
## Editing your system path on Windows
22 1 Redmine Admin
23 168 Ted Sume
Open Run (Windows Key + R), then type *SystemPropertiesAdvanced* and press Enter. 
24
On the bottom third of the resulting dialog, click the Environment Variables button. 
25
In System Variables, highlight Path and click Edit. This is where you make changes to your system path.
26 1 Redmine Admin
27 112 David Alexander
## If your machine is on a Windows Domain (as compared to a WORKGROUP), then ensure that Windows knows its domainname
28 1 Redmine Admin
29 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.
30 89 David Alexander
31 1 Redmine Admin
* From a command prompt, type the command: 
32
33
~~~~~~
34
ipconfig /all
35
~~~~~~
36
37 96 David Alexander
Look for the value of the "Primary Dns Suffix" field, which should be your domain name (i.e. txcorp.com).
38 1 Redmine Admin
39
* If cygwin is already installed,
40
41
~~~~~~
42
ipconfig /all | grep -i "Primary Dns Suffix" | sed -e 's/^.*: //'
43
~~~~~~
44
45 89 David Alexander
should return the domainname. 
46 1 Redmine Admin
47 168 Ted Sume
* For Windows 10 machines that are not a member of the Windows Domain, Active Directory, do the following:
48 1 Redmine Admin
    1. Right click on My Computer, select properties
49
    2. Click on Advanced system settings
50
    3. Select the computer name tab
51
    4. Click the change button
52
    5. Click the more button
53
    6. Enter the Primary DNS suffix. i.e. txcorp.com 
54
55 112 David Alexander
## Create initial directories
56 1 Redmine Admin
57
* Create the folder C:\\bin (if not already present).
58
* Add or move C:\\bin to the front of your system path.
59
60 113 David Alexander
# Software "Required" for Bilder
61 1 Redmine Admin
62 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
63 37 John Cary
64 74 David Alexander
* Blat (for emailing yourself)
65 36 John Cary
* Cygwin (for bash shell)
66 1 Redmine Admin
* CMake from an installer
67 157 John Cary
* NASM from an installer
68 38 John Cary
* Python from an installer
69 1 Redmine Admin
* Latex (MikTek below)
70
* Visual Studio Express (for nmake)
71
72 162 Tech-X Corporation
If you have installed a package, you will need to open a new Cygwin window to update PATH in order for your Cygwin bash shell to find the package.  To check whether a package is in PATH, from a Cygwin shell, enter
73
74 168 Ted Sume
~~~~~~~~~~~
75 162 Tech-X Corporation
echo $PATH
76 168 Ted Sume
~~~~~~~~~~~
77 162 Tech-X Corporation
78
After installing the requirements, you can add the arguments,  -W python,cmake, and your installed Python and CMake will be used if your path is correct.
79 1 Redmine Admin
80 144 David Alexander
Since bilder uses the C++17 conformance flags, we require:
81 82 John Cary
82 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)
83 83 John Cary
* Windows 10 or Windows 10 SDK
84
85 74 David Alexander
Below is a list of the Tools and Libraries that are most often needed.
86
87
# Tools (Required for most common builds within Bilder)
88
89 1 Redmine Admin
## Blat
90
91 167 John Cary
* Blat is a sendmail client for Windows needed to send emails.*
92 149 David Alexander
93 1 Redmine Admin
* Download Blat from [The Blat SourceForge](http://sourceforge.net/projects/blat) Site and extract all files. The latest version should be fine.
94 150 David Alexander
* Extract the zip file (e.g. blat3222_32.full.zip) into C:\\bin.
95
* Copy the contents of the "full" directory up two diretories into "C:\bin" (i.e. C:\bin\blat3222\full\blat.{exe,dll} to C:\bin\blat.{exe,dll}).
96
* Execute the following command in a cygwin terminal to check that it works
97 1 Redmine Admin
98
~~~~~~
99 168 Ted Sume
    blat -install <mail server hostname> <username>@txcorp.com
100 1 Redmine Admin
~~~~~~
101
102
## CMake
103
104 167 John Cary
* CMake is a cross-platform build system needed to configure many of necessary packages.*
105 1 Redmine Admin
106 168 Ted Sume
* Install [CMake](http://www.cmake.org/files/).
107
  * Version 3.27 is what we use as of Feb 2024. However, picking a later version is better because it will allow bilder to build future versions of cmake.
108 26 John Cary
  * Add the CMake path to the front of the system path! (Needed to build newer 64 bit versions through Bilder)
109 1 Redmine Admin
  * When this step is complete, make sure the newest CMake is the only one in your system path.
110
111 10 Redmine Admin
## CYGWIN
112 1 Redmine Admin
113 74 David Alexander
*Cygwin is a Unix shell program for Windows and is needed to run the bash code of Bilder.*
114
115 1 Redmine Admin
### Gotchas (in advance)
116
117 163 Ted Sume
* Need at least version 7.59 of curl
118 1 Redmine Admin
* Do not install Cygwin's MinGW. Those are installed in a separate area to reduce conflicts.
119
* 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'.
120
* Do not install Cygwin's mt.  If 'which mt' returns /bin/mt or /usr/bin/mt, then move this aside too.
121 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.)
122 1 Redmine Admin
* Make sure that 'which find' returns the cygwin version (/usr/bin/find), not the Windows version.
123
* Make sure 'which cmd' returns the Windows version. If not, check that your bash_profile has not made an error in setting your path.
124
* 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.
125
126
### Updating Cygwin
127
128
* 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.
129
* 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.
130
* Recreate the /etc/passwd and /etc/group file again using the mkpasswd and mkgroup commands described in the Configuring Cygwin section.
131
* 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).
132
* Upon running setup-*.exe, select the packages:
133 3 Redmine Admin
  * Base -> util-linux
134
  * Devel -> bison
135
  * Devel -> flex
136 4 Redmine Admin
  * Devel -> gcc-g++ and gcc-fortran (4.9.3 does not compile sqlite, so choose 4.9.2)
137 3 Redmine Admin
  * Devel -> git
138
  * Devel -> make
139
  * Devel -> mercurial
140 1 Redmine Admin
  * Devel -> patch
141 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.)
142 3 Redmine Admin
  * Editors -> vim and emacs (and alternate editors of choice)
143
  * Math -> bc
144
  * Net -> openssh
145 25 Matt Copper
  * Net -> curl
146 3 Redmine Admin
  * Python -> python (see note below)
147
  * Shells -> mintty
148
  * Utils -> diffutils
149
  * Utils -> dos2unix
150
  * Web -> wget
151 1 Redmine Admin
152
* 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).
153
154
* 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.
155
* 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.
156
157
### Setting Cygwin Disk Mounts
158
159
* 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:
160
161
~~~~~~
162
mkdir /cygdrive/c/winsame
163
mkdir /winsame
164
mount C:/winsame /winsame
165
~~~~~~
166
167
To make this permanent, put
168
169
~~~~~~
170
C:/winsame /winsame ntfs binary 0 0
171
~~~~~~
172
173
as one line in /etc/fstab.
174
175
On Windows-64, additionally put
176
177
~~~~~~
178
C:/Program\040Files\040(x86) /ProgramFilesX86 ntfs binary 0 0
179
~~~~~~
180
181
as one line in /etc/fstab.  This allows one to construct a valid path with no parentheses as needed for ATLAS.
182
183
### Configuring Cygwin
184
185 6 Redmine Admin
* Use a "Cygwin64 Terminal" from basic cygwin installation above to perform all subsequent bash tasks
186 1 Redmine Admin
187
* If bilderizing a domain machine, create an /etc/passwd file with the following command
188
189
~~~~~~
190
mkpasswd -l -d -p /winsame > /etc/passwd
191
~~~~~~
192
193 71 Tech-X Corporation
* Add a single domain user to an already created /etc/password:
194
195
~~~~~~
196
mkpasswd -l -d -u {username} -p /winsame >> /etc/passwd
197
~~~~~~
198
199 1 Redmine Admin
* If bilderizing a non-domain machine, create an /etc/passwd file with the following command
200
201
~~~~~~
202
mkpasswd -l -p /winsame > /etc/passwd
203
~~~~~~
204
205
* If bilderizing a domain machine, create an /etc/group file with the following command
206
207
~~~~~~
208
mkgroup -l -d > /etc/group
209
~~~~~~
210
211
* If bilderizing a non-domain machine, create an /etc/group file with the following command
212
213
~~~~~~
214
mkgroup -l > /etc/group
215
~~~~~~
216
217
* 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:
218
219
~~~~~~
220
cp /home/<username>/.* /winsame/<username>/
221
rm -rf /home/<username>
222
~~~~~~
223 52 John Cary
224 146 David Alexander
## Dependencies Tool
225 52 John Cary
226 146 David Alexander
*Dependencies* is a tool that shows the DLL's that an executable depends on and is needed to find and copy-in DLLs to a final distribution.
227 5 Redmine Admin
228 151 John Cary
Download [Dependencies](https://lucasg.github.io/Dependencies/) and copy Dependencies*, ClrPhlib.{dll,pdb} into C:\\bin.
229
(NDesk.Option.dll not needed.)
230 1 Redmine Admin
231
## JOM
232
233 167 John Cary
* JOM is an nmake wrapper needed to give  the -j flag capability of Unix make for faster compilation.*
234 1 Redmine Admin
235
* Create the folder C:\bin (if not already present).
236
* Add C:\bin to your system path (if not already there).
237
* Download jom.zip from [the Qt Project](https://wiki.qt.io/Jom).
238
* Extract the contents of jom.zip
239
* Move/copy jom.exe to C:\bin (you then can delete the remainder of the contents or keep for historical reasons).
240
241
## LaTeX
242
243 74 David Alexander
*LaTeX is a typesetting tool needed for building PDF files for user documentation.*
244 1 Redmine Admin
245 123 Benjamin Cowan
* Install [Doxygen](http://www.doxygen.nl/).  Choose "Letter" for paper size and "Yes" for "Install missing packages on-the-fly".
246 92 John Cary
* Install Basic MikTeX from [MikTeX](http://miktex.org/). Use the MikTeX Package Manager to install the packages noted at
247
[[LaTeX packages needed by Bilder]]
248 124 Benjamin Cowan
* Install [ghostscript](https://www.ghostscript.com/download/gsdnld.html).
249 1 Redmine Admin
250 166 John Cary
## LLVM (Clang)
251 1 Redmine Admin
252 166 John Cary
### Installing LLVM-Clang from a binary installer (easiest way)
253
254
Download the Windows (64-bit) installer from http://releases.llvm.org/download.html, and proceed with the installation.
255
256
When installing namespace the installation directory with the major version.  Eg, change LLVM to LLVM17 when asked.
257
258 1 Redmine Admin
## MPI
259
260 74 David Alexander
*MPI is a message passing interface for parallel code that is needed for some computation engines.*
261
262 98 Ted Sume
Download Microsoft MPI v8.1.1 from:
263 1 Redmine Admin
264 98 Ted Sume
https://www.microsoft.com/en-us/download/details.aspx?id=55991
265 1 Redmine Admin
266 93 John Cary
The binaries (e.g., mpiexec) are obtained by installing msmpisetup.exe.
267 1 Redmine Admin
268 94 John Cary
The libraries (msmpi.lib) are obtained by installing msmpisdk.msi.
269 1 Redmine Admin
270 93 John Cary
The installers will put mpiexec in your path and define the environment variables,
271
272
MSMPI_INC
273
MSMPI_BIN
274
MSMPI_LIB32
275
MSMPI_LIB64
276
277
which are used by CMake, e.g., to find the needed components of MSMPI.
278 157 John Cary
279
## NASM (required to build OpenSSL, therefore CMake)
280
281
* Download and install from https://nasm.us/
282 158 John Cary
* Make sure this appropriate modifications to your path are made
283 1 Redmine Admin
284 85 John Cary
## Perl (required to build OpenSSL, therefore CMake)
285 74 David Alexander
286 1 Redmine Admin
*Perl is a programming language needed by some packages such as Qt*
287
288
* Download and install [ActiveState Perl](http://www.activestate.com/activeperl/downloads).
289 74 David Alexander
290
## Python
291 1 Redmine Admin
292 166 John Cary
* Python is built or installed by Bilder.
293 1 Redmine Admin
294 107 John Cary
## RCEDIT
295
296
* 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.
297
298 85 John Cary
## Ruby (required to build Qt5)
299
300
* Ruby, http://rubyinstaller.org/, must be installed first.
301
302 1 Redmine Admin
## Subversion
303
304 74 David Alexander
* Subversion is a revision control tool needed by bilder, for example, to know when packages are out of date.*
305 1 Redmine Admin
306 108 Benjamin Cowan
* Install [TortoiseSVN](https://tortoisesvn.net/downloads.html) with its command line tools.
307 1 Redmine Admin
308 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).
309 33 Tech-X Corporation
310 1 Redmine Admin
~~~~~~
311
$ where svn
312 84 John Cary
C:\cygwin64\bin\svn.exe
313
C:\PROGRAM FILES\TORTOISESVN\bin\svn.exe
314
$ /usr/bin/svn --version | head -1
315
svn, version 1.9.7 (r1800392)
316 1 Redmine Admin
$ /cygdrive/c/Program\ Files/TortoiseSVN/bin/svn --version | head -n 1
317 15 Redmine Admin
svn, version 1.9.7 (r1800392)
318 1 Redmine Admin
~~~~~~
319
320
## Visual Studio
321
322 166 John Cary
* Visual Studio contains the Microsoft command-line compiler (cl) used by packages with C/C++ code.* 
323 1 Redmine Admin
324 166 John Cary
* Bilder uses VS2019 (MACHINE_FILE=${MACHINE_FILE:-"cygwin.llvm_vs2017"}) by default.  We are moving to llvm17_vs2022.
325 1 Redmine Admin
326 166 John Cary
* Visual Studio should not be in the system path. (Bilder adds this as needed.)
327 78 Ted Sume
328 165 John Cary
329 166 John Cary
### CUDA
330 145 John Cary
331 166 John Cary
* Bilder currently uses CUDA-11.8 by default, if is can find it.
332 165 John Cary
333 1 Redmine Admin
~~~~~~
334
BILDER_CUDA_FIND_VERSIONS=${BILDER_CUDA_FIND_VERSIONS:-"11.8 11.7 11.6 11.5 11.2 11.1 11.0 10.2 10.1"}
335 166 John Cary
~~~~~~
336 167 John Cary
337
* We are moving to CUDA-12.3
338 153 Ted Sume
339
# WSL on Windows 10 1909 or newer 
340
341
* From within an Administrator enable Powershell window, run the following
342
343
```
344
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
345
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
346
```
347
* Reboot the computer after running the above two commands from within Powershell
348
* Update Kernel for WSL2 by downloading and installing https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi
349
* Run the following command from within an Administrator enabled Powershell window to set the default WSL version to 2.
350
351
```
352
wsl --set-default-version 2
353
```
354
* Go to Microsoft store, search for preferred Linux distro, download and install per on screen instructions.
355
356 1 Redmine Admin
357
# Libraries (Required for most builds with Bilder)
358
359
## OpenSSL
360 85 John Cary
361
*OpenSSL is a security library needed by Python to build the SSL module, by cmake, libssh, and by Qt.*
362 1 Redmine Admin
*We no longer install OpenSSL on Windows, as Bilder builds it to be consistent with the compiler in use."
363 85 John Cary
364
### Legacy instructions.
365 1 Redmine Admin
366 75 John Cary
* Download from http://slproweb.com/products/Win32OpenSSL.html
367 76 John Cary
* Choose the Win64 OpenSSL v1.0.2n  (not Light) on 64bit or the Win32 OpenSSL v1.0.2n on 32bit windows.
368 1 Redmine Admin
* **The 1.1 series DOES NOT WORK with either libssh or Qt.**
369
* You may have to install Visual C++ Redistributables if the installer complains.
370
* During the installation, select "Copy OpenSSL DLLs to: The OpenSSL binaries (/bin) directory"
371
* 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.
372
* 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:
373 30 John Cary
374
~~~~~~
375 1 Redmine Admin
which libeay32.dll
376 73 Tech-X Corporation
/cygdrive/c/OpenSSL-Win64/bin/libeay32.dll
377 30 John Cary
~~~~~~
378 1 Redmine Admin
379
* If built software has unexplained crashes, recheck the above command results.
380 109 Tech-X Corporation
381
382
# Composer-related Libraries (only needed for building ComposerToolkit, can be skipped for documentation builds)
383 125 Nathan Neri
384
## Git LFS
385
386
*Git LFS is a git extension for repos with large files - needed to use git for VisIt repos*
387
388
Download and run the installer: https://git-lfs.github.com/
389 130 Nathan Neri
390 125 Nathan Neri
You can adjust the configuration by running (from Cygwin) `git lfs install --force --skip-smudge` with new configuration options.
391 127 Nathan Neri
392
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.
393
394
~~~~~~
395
LINK_TO_PATH=`which git-lfs.exe`
396
LINK_FROM_PATH=`git --exec-path`
397
cd $LINK_FROM_PATH
398
ln -s "$LINK_TO_PATH" git-lfs.exe
399
~~~~~~
400 74 David Alexander
401 1 Redmine Admin
## Qt
402 74 David Alexander
403
*Qt is a cross-platform GUI library needed to build packages that have Qt-based user interfaces.*
404 142 David Alexander
405 1 Redmine Admin
Qt5 is the recommended version (the previous version, Qt4, instructions are also here too until Qt5 is solid).
406 142 David Alexander
407
### Installing Qt5
408 159 David Alexander
409 142 David Alexander
These instructions are how to install the pre-built version of Qt 5 (version 5.14.2).  You can skip creating the Qt account.
410 159 David Alexander
411
* Get Qt-5.14.2 from https://download.qt.io/archive/qt/5.14/5.14.2/qt-opensource-windows-x86-5.14.2.exe
412 160 David Alexander
* Run this program, selecting `<DRIVE>\winsame\winqt\5.14.2` 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)
413 1 Redmine Admin
* Expand the Qt 5.14.2 section and select the following components:
414 160 David Alexander
  * MSVC 2017 64-bit
415 1 Redmine Admin
  * UWP x64 (MSVC 2017)
416 142 David Alexander
  * Sources
417 160 David Alexander
  * Qt WebEngine
418
* Optionally, under Developer and Designer Tools, select:
419
  * Qt Creator 4.11.1 CDB Debugger Support
420 142 David Alexander
  * Qt Creator 4.11.1 is selected by default
421
* Accept all remaining defaults unless otherwise preferred
422 143 David Alexander
423 74 David Alexander
### Building and Installing Qt4
424 41 John Cary
425 114 Nathan Neri
* Make sure no other Qt is in your system path.
426 118 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.)
427 41 John Cary
* 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).
428 1 Redmine Admin
* If 4.8.7, patch Qt by opening a Cygwin window:
429
430
~~~~~~
431 100 John Cary
cd /winsame/builds-vs12/winqt/4.8.7
432
~~~~~~
433 106 John Cary
434 100 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
435
436 119 Nathan Neri
~~~~~~
437 1 Redmine Admin
/path/to/bilder/installed/python -m patch /path/to/bilder/patches/02-fix_build_with_msvc2015-45e8f4ee.diff
438
~~~~~~
439 74 David Alexander
440 1 Redmine Admin
#### Compiling Qt4
441
442
* The copy/paste-able commands below assume VS12.
443
444
In a Visual Studio x64 DOS window:
445
446 116 Nathan Neri
~~~~~~
447
set VER=2017
448 120 Nathan Neri
REM could be 12
449
set DRIVE=C:
450 1 Redmine Admin
REM or D:, if you're building there
451
set SFX=vs%VER%
452
REM or whatever machine suffix you will be building for, if using a combined compiler build
453 120 Nathan Neri
set QTVER=4.8.7
454 1 Redmine Admin
set INSTALL_DIR=%DRIVE%\winsame\builds-%SFX%\winqt\%QTVER%\%QTVER%\msvc%VER%_64
455
~~~~~~
456 103 John Cary
457 1 Redmine Admin
Modify the last line as needed, e.g., different drive or subdir.
458 106 John Cary
459 1 Redmine Admin
Set the platform args according to your compiler.
460 106 John Cary
461
For VS2013 (VS12).
462 101 John Cary
463 106 John Cary
~~~~~~
464 101 John Cary
set PLATFORM_ARGS=-platform win32-msvc2013
465
~~~~~~
466 106 John Cary
467 101 John Cary
For VS2015 or VS2017:
468
469 106 John Cary
~~~~~~
470 101 John Cary
set PLATFORM_ARGS=-platform win32-msvc2015
471 1 Redmine Admin
~~~~~~
472
473
Then
474
475 120 Nathan Neri
~~~~~~
476
%DRIVE%
477 116 Nathan Neri
cd %DRIVE%\winsame\builds-%SFX%\winqt\%QTVER%
478 1 Redmine Admin
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%
479
~~~~~~
480
481
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)
482 106 John Cary
483 99 John Cary
~~~~~~
484
export VER=12 # or 2017
485 44 John Cary
export SFX=vs${VER}
486 115 John Cary
cd /winsame/builds-${SFX}/winqt/4.8.7
487
export INSTALL_DIR=/winsame/builds-${SFX}/winqt/4.8.7/4.8.7/msvc${VER}_64
488 139 David Alexander
mkdir -p ${INSTALL_DIR}
489 128 Nathan Neri
cp -R mkspecs ${INSTALL_DIR}
490
~~~~~~
491 137 David Alexander
492 128 Nathan Neri
Back in the Visual Studio x64 DOS window
493
494
~~~~~~
495
%DRIVE%
496 1 Redmine Admin
cd %DRIVE%\winsame\builds-%SFX%\winqt\4.8.7 
497
set PATH=%PATH%;%DRIVE%\winsame\builds-%SFX%\winqt\4.8.7\bin
498 128 Nathan Neri
nmake
499
REM Took 3.5 hours on a 2.3 GHz Core2 Duo with Solid State Drive
500
nmake install
501
REM Took 10 minutes on a 2.3 GHZ Core2 Duo with Solid State Drive
502
~~~~~~
503 1 Redmine Admin
504
* For CMake to find Qt, add INSTALL_DIR to your supra search path when configuring.
505 142 David Alexander
506
* 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.
507 140 David Alexander
508
509
# Additional Useful Tools
510
511
## Notepad++
512
513
* (Optional) Notepad++ is a free source code editor that is a great tool for Windows.
514
* Download from http://notepad-plus-plus.org/
515 1 Redmine Admin
* Install and pin to your taskbar.
516 110 David Alexander
517
## Java
518
519
Java is needed for setting up the machine to be a Jenkins Slave.
520
521
* Download from https://www.java.com/en/download/  (Version 8 Update 181 has a Release date of July 17, 2018) 
522 111 David Alexander
* May get a message about the Java Plugin and Chrome. This does not affect the Jenkins slave service.
523
* Download the JNLP page from the Jenkins server site (link button with label "Launch agent from browser").
524 110 David Alexander
* Start a command prompt running as Administrator, then change to the Download directory and type "javaws slave-agent.jnlp" 
525
* Choose File -> "Install as a service" and follow the dialog messages.
526 1 Redmine Admin
527
# Experimental Tools and Libraries
528
529
These tools have not been fully vetted or built, so you need not do these.
530
531
## MinGW
532
533
See [[Installing MinGW]].
534
535
## ATLAS
536
537 8 Redmine Admin
See [[Installing ATLAS on Windows]].
538 131 John Cary
539
## OpenBLAS
540
541
See [[Installing OpenBlas on Windows]]
542 1 Redmine Admin
543 8 Redmine Admin
# Cygwin and Paths
544 1 Redmine Admin
545
(This section assumes the user is familiar with the relations between Cygwin and Windows paths.)
546
547
The path is critical for when there are conflicting executables.  This is the case for Subversion and OpenSSL.
548
549
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.
550
551
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.
552
553
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.
554
555
## Usage under Jenkins
556
557
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.
558
559
560
## Summary
561
562
* Bilder moves `/usr/bin` to just after the Python path and therefore to before
563
  `/cygdrive/c/Windows/system32`.
564
* Put the Windows Subversion path behind the Python path (and so behind `/usr/bin`).
565
    - `/usr/bin` must be removed from the path when configuring some packages in order to get the correct subversion when building under Jenkins.
566
567
# Bilder machine files for cygwin
568
569
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.
570
571
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.
572
573
# Setup for making Installers
574
575
## Visual Studios Redistributables
576
577
Download vcredist_x64.exe (Visual C++ Redistributable Packages for Visual Studio 2013)
578
579
http://www.microsoft.com/en-gb/download/details.aspx?id=40784
580 161 David Alexander
581 1 Redmine Admin
Choose only vcredist_x64.exe executable from list. This should put vcomp120.dll in C:\Windows\System32\
582
583
## Sign Tools
584
585
* 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.
586
* 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: 
587
588 74 David Alexander
~~~~~~
589
cd C:\Windows\System32
590
REGSVR32 capicom.dll
591
~~~~~~
592
593
## NSIS
594
595 1 Redmine Admin
NSIS is a scriptable installer maker.
596
597 131 John Cary
* Install NSIS from [NSIS Download Site](http://nsis.sourceforge.net/Download).
598
  * 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.
599 88 John Cary
  * Version 2.46 is available as of Aug 21, 2011.
600 74 David Alexander
* Add `C:\Program Files (x86)\NSIS\Bin` to your system path.
601
602
* Install NSIS Access Control Plugin from [Access Control Plugin Site](http://nsis.sourceforge.net/AccessControl_plug-in).
603
604
Copies directories and files into the NSIS installation as follows:
605
606
~~~~~~
607
AccessControl.zip\Contrib\AccessControl --> NSIS\Contrib\AccessControl
608 1 Redmine Admin
AccessControl.zip\Docs\AccessControl --> NSIS\Docs\AccessControl
609
AccessControl.zip\Plugins\AccessControl.dll --> NSIS\Plugins\x86-ansi\AccessControl.dll
610
AccessControl.zip\Unicode\Plugins\AccessControl.dll --> NSIS\Plugins\x86-unicode\AccessControl.dll
611
~~~~~~
612 155 David Alexander
613
614
# Path
615
616
The resulting Windows PATH should look like this...
617 156 David Alexander
618 155 David Alexander
![](windowsPath.png)
619 1 Redmine Admin
620
# Notes For Development
621
622
[[Notes on debugging Windows executables]]
623 154 Ted Sume
[[Notes on deleting directories and files owned by other users]]
624 1 Redmine Admin
[[Notes on enabling and disabling the Windows Firewall from the command line]]