Skip to content

Commit 64ad3a9

Browse files
authored
Windows compile instructions (#33)
Update README.md
1 parent 27f6b79 commit 64ad3a9

File tree

1 file changed

+87
-2
lines changed

1 file changed

+87
-2
lines changed

README.md

Lines changed: 87 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,93 @@ See [Wireshark Documentation on Plugin Folders](https://www.wireshark.org/docs/w
3939
4. After installing the plugin, verify that the plugin is loaded by searching `smf` under the `Plugins` tab
4040

4141
## Building Manually
42-
43-
TODO
42+
Go to an appropriate directory and execute:
43+
```
44+
git clone --recurse-submodules git@github.com:SolaceLabs/wireshark-smf-plugin.git
45+
```
46+
Note: If you plan to submit changes, create a fork first and clone from the fork.
47+
48+
### Windows
49+
#### Windows Build
50+
Follow instructions in https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWindows
51+
52+
The following are some deviations from the above instructions.
53+
Use a cmd prompt with admin privilege:
54+
```
55+
cd base-directory-of-wireshark-smf-plugin
56+
mkdir build
57+
mklink CMakeListsCustom.txt ..\src\CMakeListsCustom.txt
58+
cd plugins\epan
59+
mklink /D smf ..\..\..\src\smf
60+
```
61+
In vscode, my task.json looks like this:
62+
```json
63+
{
64+
"version": "2.0.0",
65+
"tasks": [
66+
{
67+
"label": "Pre-Build Files (cmake)",
68+
"type": "shell",
69+
"group":"build",
70+
"options": {
71+
"cwd": "build",
72+
"env": {
73+
"WIRESHARK_BASE_DIR": "C:\\my-path\\wireshark-smf-plugin",
74+
"QT6_DIR": "C:\\Qt\\6.7.3\\msvc2022_64",
75+
"WIRESHARK_VERSION_EXTRA": "-YourExtraVersionInfo"
76+
}
77+
},
78+
"command": "cmake -DVCSVERSION_OVERRIDE=\"Git v3.1.0 packaged as 3.1.0-1\" -G “Visual Studio 17 2022” -A x64 ..\\wireshark",
79+
"problemMatcher": [
80+
"$msCompile"
81+
]
82+
},
83+
{
84+
"label": "Build wireshark (msbuild)",
85+
"type": "shell",
86+
"group":{
87+
"kind": "build",
88+
"isDefault": true
89+
},
90+
"options": {
91+
"cwd": "build",
92+
"env": {
93+
"WIRESHARK_BASE_DIR": "C:\\my-path\\wireshark-smf-plugin",
94+
"QT6_BASE_DIR": "C:\\Qt\\6.7.3\\msvc2022_64",
95+
"WIRESHARK_VERSION_EXTRA": "-YourExtraVersionInfo"
96+
}
97+
},
98+
"command": "msbuild /m /p:Configuration=Debug Wireshark.sln",
99+
"problemMatcher": [
100+
"$msCompile"
101+
]
102+
},
103+
{
104+
"label": "Clean wireshark (msbuild)",
105+
"type": "shell",
106+
"group":"build",
107+
"options": {
108+
"cwd": "build",
109+
"env": {
110+
"WIRESHARK_BASE_DIR": "C:\\my-path\\wireshark-smf-plugin",
111+
"QT6_BASE_DIR": "C:\\Qt\\6.7.3\\msvc2022_64",
112+
"WIRESHARK_VERSION_EXTRA": "-YourExtraVersionInfo"
113+
}
114+
},
115+
"command": "msbuild /m /p:Configuration=Debug Wireshark.sln /t:Clean"
116+
}
117+
]
118+
}
119+
```
120+
121+
Note 1: To start VSCode, start from the "X64 Native Tools Command Prompt" (search for this in Windows search box), then type "code" to start VSCode.
122+
123+
Note 2: The VCSVERSION_OVERRIDE is needed because the compile failed to find the approparite git repository.
124+
125+
### Linux
126+
TODO
127+
### MacOS
128+
TODO
44129

45130
## Version Naming Convention
46131
As this plugin is designed for use in Wireshark, the MAJOR.MINOR match the Wireshark versions. I.E. SMF Plugin 4.0.x indicates support for all patches of Wireshark 4.0.

0 commit comments

Comments
 (0)