Updates.
We use VS 2017, not VS 2015, for 2.6.x and development builds. Microsoft's documentation is moving from msdn.microsoft.com to docs.microsoft.com. The way you download pre-2017 versions of VS has changed. Update links to the Android, GNOME, KDE and macOS human interface guidelines while we're at it. Change-Id: I1a3973f76aa5b476cb906b8a8604b82d6131e9c5 Reviewed-on: https://code.wireshark.org/review/30168 Reviewed-by: Guy Harris <guy@alum.mit.edu>
This commit is contained in:
Guy Harris
parent
aba59e5973
commit
01ed5b84f3
|
|
@ -47,12 +47,12 @@ Known traps are:
|
|||
You need to install, in exactly this order:
|
||||
|
||||
. C compiler:
|
||||
https://go.microsoft.com/fwlink/?LinkId=532606&clcid=0x409[Download]
|
||||
and install ``Microsoft Visual Studio 2015 Community Edition.'' This is a small
|
||||
https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=15[Download]
|
||||
and install ``Microsoft Visual Studio 2017 Community Edition.'' This is a small
|
||||
download that then downloads all the other required parts (which are quite large).
|
||||
|
||||
Select the "Custom" install and then uncheck all the optional components other
|
||||
than "Common Tools for Visual C++ 2015" (unless you want to use them for purposes
|
||||
than "Common Tools for Visual C++ 2017" (unless you want to use them for purposes
|
||||
other than Wireshark).
|
||||
|
||||
You can use Chocolatey to install Visual Studio, to correctly configure the
|
||||
|
|
@ -63,7 +63,7 @@ and pass the path the file to the chocolatey install command:
|
|||
PS$>choco install -y VisualStudio2015Community --timeout 0 -package-parameters "--AdminFile path\to\msvc2015AdminDeployment.xml"
|
||||
----
|
||||
|
||||
You can use other Microsoft C compiler variants, but VS2015 is used to
|
||||
You can use other Microsoft C compiler variants, but VS2017 is used to
|
||||
build the development releases and is the preferred option. It’s
|
||||
possible to compile Wireshark with a wide range of Microsoft C compiler
|
||||
variants. For details see <<ChToolsMSChain>>.
|
||||
|
|
@ -81,9 +81,9 @@ of Visual Studio add more cross-platform support.
|
|||
// required components
|
||||
|
||||
Why is this recommended? While this is a huge download,
|
||||
Visual Studio 2015 Community Edition is the only free (as in beer)
|
||||
Visual Studio 2017 Community Edition is the only free (as in beer)
|
||||
versions that includes the Visual Studio integrated
|
||||
debugger. Visual Studio 2015 is also used to create official
|
||||
debugger. Visual Studio 2017 is also used to create official
|
||||
Wireshark builds, so it will likely have fewer development-related
|
||||
problems.
|
||||
|
||||
|
|
@ -95,15 +95,15 @@ The main Wireshark application uses the Qt windowing toolkit. To install
|
|||
Qt download the *Qt Online Installer for Windows* from the Qt Project
|
||||
https://www.qt.io/download-open-source/["Download Open Source" page] and
|
||||
select a component that matches your target system and compiler. For
|
||||
example, the ``msvc2015 64-bit'' component is used to build the official
|
||||
example, the ``msvc2017 64-bit'' component is used to build the official
|
||||
64-bit packages. You can deselect all the Qt xxxx (e.g. Qt Charts)
|
||||
components as they aren't required.
|
||||
|
||||
Note that installation of separate Qt components are required for 32 bit
|
||||
and 64 bit builds, e.g. ``msvc2015 32-bit'' and ``msvc2015 64-bit''. The
|
||||
and 64 bit builds, e.g. ``msvc2017 32-bit'' and ``msvc2017 64-bit''. The
|
||||
environment variable `QT5_BASE_DIR` should be set as appropriate for your
|
||||
environment and should point to the Qt directory that contains the bin
|
||||
directory, e.g. _C:\Qt\5.9.5\msvc2015_64_
|
||||
directory, e.g. _C:\Qt\5.9.5\msvc2017_64_
|
||||
|
||||
The Qt maintenance tool (_C:\Qt\MaintenanceTool.exe_) can be used to
|
||||
upgrade Qt to newer versions.
|
||||
|
|
@ -363,12 +363,12 @@ Make sure your repository path doesn't contain spaces.
|
|||
==== Open a Visual Studio Command Prompt
|
||||
|
||||
From the Start Menu (or Start Screen), navigate to the `Visual Studio
|
||||
2015' folder and choose the Command Prompt appropriate for
|
||||
the build you wish to make, e.g. `VS2015 x64 Native Tools Command
|
||||
Prompt' for a 64-bit version or `VS2015 x86 Native Tools Command Prompt'
|
||||
2017' folder and choose the Command Prompt appropriate for
|
||||
the build you wish to make, e.g. `VS2017 x64 Native Tools Command
|
||||
Prompt' for a 64-bit version or `VS2017 x86 Native Tools Command Prompt'
|
||||
for a 32-bit version. Depending on your version of Windows the Command
|
||||
Prompt list might be directly under `Visual Studio 2015' or you might
|
||||
have to dig for it under multiple folders, e.g. `Visual Studio 2015 ->
|
||||
Prompt list might be directly under `Visual Studio 2017' or you might
|
||||
have to dig for it under multiple folders, e.g. `Visual Studio 2017 ->
|
||||
Visual Studio Tools -> Windows Desktop Command Prompts'.
|
||||
|
||||
[TIP]
|
||||
|
|
@ -391,7 +391,7 @@ Set the following environment variables, using paths and values suitable for you
|
|||
> set WIRESHARK_BASE_DIR=C:\Development
|
||||
> rem set WIRESHARK_LIB_DIR=c:\wireshark-win64-libs
|
||||
> rem Set the Qt installation directory
|
||||
> set QT5_BASE_DIR=C:\Qt\5.9.5\msvc2015_64
|
||||
> set QT5_BASE_DIR=C:\Qt\5.9.5\msvc2017_64
|
||||
> rem Append a custom string to the package version. Optional.
|
||||
> set WIRESHARK_VERSION_EXTRA=-YourExtraVersionInfo
|
||||
----
|
||||
|
|
@ -404,8 +404,8 @@ you can explicitly specify it with the following environment variable:
|
|||
> set WIRESHARK_CYGWIN_INSTALL_PATH=C:\ProgramData\chocolatey\lib\Cygwin\tools\cygwin
|
||||
----
|
||||
|
||||
If you are using a version of Visual Studio earlier than VS2012 then you must set an additional env var,
|
||||
e.g. for VS2010 set the following:
|
||||
If you are using a version of Visual Studio earlier than VS2017 then you must set an additional env var,
|
||||
e.g. for VS2019 set the following:
|
||||
----
|
||||
> set VisualStudioVersion=10.0
|
||||
----
|
||||
|
|
@ -453,7 +453,7 @@ If you've closed the Visual Studio Command Prompt <<ChSetupPrepareCommandCom,pre
|
|||
|
||||
To generate the build files enter the following at the Visual Studio command prompt:
|
||||
----
|
||||
> cmake -G "Visual Studio 14 2015" ..\wireshark
|
||||
> cmake -G "Visual Studio 15 2017" ..\wireshark
|
||||
----
|
||||
|
||||
Adjusting the paths as required to Python and the wireshark source tree.
|
||||
|
|
@ -462,10 +462,10 @@ all the CMake supported generators, but only Visual Studio is supported
|
|||
for Wireshark builds.
|
||||
|
||||
To build an x64 version, the `-G` parameter must have a Win64 suffix,
|
||||
e.g. `-G "Visual Studio 14 2015 Win64"`:
|
||||
e.g. `-G "Visual Studio 15 2017 Win64"`:
|
||||
|
||||
----
|
||||
> cmake -G "Visual Studio 14 2015 Win64" ..\wireshark
|
||||
> cmake -G "Visual Studio 15 2017 Win64" ..\wireshark
|
||||
----
|
||||
|
||||
The CMake generation process will download the required 3rd party libraries (apart from Qt)
|
||||
|
|
|
|||
|
|
@ -343,7 +343,8 @@ _windows.h_, _WSock32.lib_)
|
|||
|
||||
==== Official Toolchain Packages And Alternatives
|
||||
|
||||
The official Wireshark 2.4.x releases are compiled using Microsoft Visual {cpp} 2015.
|
||||
The official Wireshark 2.6.x releases are compiled using Microsoft Visual {cpp} 2017.
|
||||
The Wireshark 2.4.x releases are compiled using Microsoft Visual {cpp} 2015.
|
||||
The Wireshark 2.2.x and 2.0.x releases are compiled using Microsoft Visual {cpp} 2013.
|
||||
The Wireshark 1.12.x and 1.10.x releases were compiled using
|
||||
Microsoft Visual {cpp} 2010 SP1.
|
||||
|
|
@ -365,14 +366,25 @@ package is to be used. See
|
|||
<<msvc-runtime-redistributable>> below for more details.
|
||||
|
||||
However, you might already have a different Microsoft {cpp} compiler
|
||||
installed. It should be possible to use any of the following with the considerations listed:
|
||||
installed. It should be possible to use any of the following with the
|
||||
considerations listed. You will need to sign up for a
|
||||
https://visualstudio.microsoft.com/dev-essentials/[Visual Studio Dev
|
||||
Essentials] account if you don't have a Visual Studio (MSDN)
|
||||
subscription. The older versions can be downloaded from
|
||||
https://visualstudio.microsoft.com/vs/older-downloads/[].
|
||||
|
||||
.Visual {cpp} 2015 Community Edition
|
||||
|
||||
IDE + Debugger?:: Yes
|
||||
|
||||
SDK required for 64-bit builds?:: No
|
||||
|
||||
CMake Generator: *`Visual Studio 14`*
|
||||
|
||||
.Visual {cpp} 2013 Community Edition
|
||||
|
||||
IDE + Debugger?:: Yes
|
||||
|
||||
Purchase required?:: http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs#d-community[Free Download]
|
||||
|
||||
SDK required for 64-bit builds?:: No
|
||||
|
||||
CMake Generator: *`Visual Studio 12`*
|
||||
|
|
@ -381,8 +393,6 @@ CMake Generator: *`Visual Studio 12`*
|
|||
|
||||
IDE + Debugger?:: Yes
|
||||
|
||||
Purchase required?:: http://www.microsoft.com/express/Downloads/#Visual_Studio_2010_Express_Downloads[Free Download]
|
||||
|
||||
SDK required for 64-bit builds?:: Yes.
|
||||
|
||||
CMake Generator: *`Visual Studio 10`*
|
||||
|
|
@ -451,7 +461,7 @@ usage: cl [ option... ] filename... [ /link linkoption...
|
|||
However, the version string may vary.
|
||||
|
||||
Documentation on the compiler can be found at
|
||||
http://msdn.microsoft.com/en-us/library/wk21sfcf.aspx[Microsoft MSDN]
|
||||
https://docs.microsoft.com/en-us/cpp/build/reference/compiling-a-c-cpp-program?view=vs-2017[Microsoft Docs]
|
||||
|
||||
==== link.exe (Linker)
|
||||
|
||||
|
|
@ -475,7 +485,7 @@ Copyright (C) Microsoft Corporation. All rights reserved.
|
|||
However, the version string may vary.
|
||||
|
||||
Documentation on the linker can be found at
|
||||
http://msdn.microsoft.com/en-us/library/t2fck18t.aspx[Microsoft MSDN]
|
||||
https://docs.microsoft.com/en-us/cpp/build/reference/linking?view=vs-2017[Microsoft Docs]
|
||||
|
||||
[[msvc-runtime-redistributable]]
|
||||
|
||||
|
|
@ -509,10 +519,10 @@ can't be legally redistributed by third parties like
|
|||
us.
|
||||
====
|
||||
|
||||
The following MSDN link is recommended for the
|
||||
The following Microsoft Docs link is recommended for the
|
||||
interested reader:
|
||||
|
||||
* http://msdn.microsoft.com/en-us/library/ms235299.aspx[Redistributing Visual C++ Files]
|
||||
* https://docs.microsoft.com/en-us/cpp/ide/redistributing-visual-cpp-files?view=vs-2017[Redistributing Visual C++ Files]
|
||||
|
||||
In all cases where _vcredist_x86.exe_ or _vcredist_x64.exe_ is
|
||||
downloaded it should be downloaded to the directory into which the support
|
||||
|
|
@ -524,7 +534,7 @@ It need not, and should not, be run after being downloaded.
|
|||
|
||||
There are three redistribution methods that MSDN
|
||||
mentions for MSVC 2013 (see:
|
||||
http://msdn.microsoft.com/en-us/library/vstudio/ms235316(v=vs.120).aspx["Choosing a Deployment Method"]):
|
||||
https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2013/ms235316(v=vs.120)["Choosing a Deployment Method"]):
|
||||
|
||||
. _Using Visual {cpp} Redistributable Package._
|
||||
The Microsoft libraries are installed by copying
|
||||
|
|
@ -692,7 +702,7 @@ debugging with the Visual Studio integrated debugger it can be helpful if you
|
|||
have to debug on a machine where an integrated debugger is not available.
|
||||
|
||||
You can get it free of charge from Microsoft in several ways, see the
|
||||
http://msdn.microsoft.com/en-us/library/windows/hardware/ff551063%28v=vs.85%29.aspx)[Debugging tools for Windows] page.
|
||||
https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/[Debugging tools for Windows] page.
|
||||
|
||||
You can also use Chocolatey to install WinDbg:
|
||||
|
||||
|
|
|
|||
|
|
@ -260,21 +260,21 @@ Exchange listed below.
|
|||
For further reference, see the following:
|
||||
|
||||
* Android Design:
|
||||
http://developer.android.com/design/index.html[]. Wireshark doesn't have
|
||||
https://developer.android.com/design/[]. Wireshark doesn't have
|
||||
a mobile frontend (not yet, at least) but there is still useful
|
||||
information here.
|
||||
|
||||
* GNOME Human Interface Guidelines:
|
||||
http://library.gnome.org/devel/hig-book/stable/[]
|
||||
https://developer.gnome.org/hig/stable/[]
|
||||
|
||||
* The KDE Usability/HIG project:
|
||||
http://techbase.kde.org/Projects/Usability/HIG[]
|
||||
* KDE Human Interface Guidelines:
|
||||
https://hig.kde.org[]
|
||||
|
||||
* macOS Human Interface Guidelines:
|
||||
https://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/AppleHIGuidelines/Intro/Intro.html[]
|
||||
https://developer.apple.com/design/human-interface-guidelines/macos/overview/themes/[]
|
||||
|
||||
* Design apps for the Windows desktop:
|
||||
http://msdn.microsoft.com/en-us/library/Aa511258.aspx[]
|
||||
* Design guidelines for the Windows desktop:
|
||||
https://docs.microsoft.com/en-us/windows/desktop/uxguide/guidelines[]
|
||||
|
||||
* User Experience Stack Exchange:
|
||||
https://ux.stackexchange.com/[]
|
||||
|
|
|
|||
Loading…
Reference in New Issue