-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
87 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,8 +39,93 @@ See [Wireshark Documentation on Plugin Folders](https://www.wireshark.org/docs/w | |
4. After installing the plugin, verify that the plugin is loaded by searching `smf` under the `Plugins` tab | ||
|
||
## Building Manually | ||
|
||
TODO | ||
Go to an appropriate directory and execute: | ||
``` | ||
git clone --recurse-submodules [email protected]:SolaceLabs/wireshark-smf-plugin.git | ||
``` | ||
Note: If you plan to submit changes, create a fork first and clone from the fork. | ||
|
||
### Windows | ||
#### Windows Build | ||
Follow instructions in https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWindows | ||
|
||
The following are some deviations from the above instructions. | ||
Use a cmd prompt with admin privilege: | ||
``` | ||
cd base-directory-of-wireshark-smf-plugin | ||
mkdir build | ||
mklink CMakeListsCustom.txt ..\src\CMakeListsCustom.txt | ||
cd plugins\epan | ||
mklink /D smf ..\..\..\src\smf | ||
``` | ||
In vscode, my task.json looks like this: | ||
```json | ||
{ | ||
"version": "2.0.0", | ||
"tasks": [ | ||
{ | ||
"label": "Pre-Build Files (cmake)", | ||
"type": "shell", | ||
"group":"build", | ||
"options": { | ||
"cwd": "build", | ||
"env": { | ||
"WIRESHARK_BASE_DIR": "C:\\my-path\\wireshark-smf-plugin", | ||
"QT6_DIR": "C:\\Qt\\6.7.3\\msvc2022_64", | ||
"WIRESHARK_VERSION_EXTRA": "-YourExtraVersionInfo" | ||
} | ||
}, | ||
"command": "cmake -DVCSVERSION_OVERRIDE=\"Git v3.1.0 packaged as 3.1.0-1\" -G “Visual Studio 17 2022” -A x64 ..\\wireshark", | ||
"problemMatcher": [ | ||
"$msCompile" | ||
] | ||
}, | ||
{ | ||
"label": "Build wireshark (msbuild)", | ||
"type": "shell", | ||
"group":{ | ||
"kind": "build", | ||
"isDefault": true | ||
}, | ||
"options": { | ||
"cwd": "build", | ||
"env": { | ||
"WIRESHARK_BASE_DIR": "C:\\my-path\\wireshark-smf-plugin", | ||
"QT6_BASE_DIR": "C:\\Qt\\6.7.3\\msvc2022_64", | ||
"WIRESHARK_VERSION_EXTRA": "-YourExtraVersionInfo" | ||
} | ||
}, | ||
"command": "msbuild /m /p:Configuration=Debug Wireshark.sln", | ||
"problemMatcher": [ | ||
"$msCompile" | ||
] | ||
}, | ||
{ | ||
"label": "Clean wireshark (msbuild)", | ||
"type": "shell", | ||
"group":"build", | ||
"options": { | ||
"cwd": "build", | ||
"env": { | ||
"WIRESHARK_BASE_DIR": "C:\\my-path\\wireshark-smf-plugin", | ||
"QT6_BASE_DIR": "C:\\Qt\\6.7.3\\msvc2022_64", | ||
"WIRESHARK_VERSION_EXTRA": "-YourExtraVersionInfo" | ||
} | ||
}, | ||
"command": "msbuild /m /p:Configuration=Debug Wireshark.sln /t:Clean" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
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. | ||
|
||
Note 2: The VCSVERSION_OVERRIDE is needed because the compile failed to find the approparite git repository. | ||
|
||
### Linux | ||
TODO | ||
### MacOS | ||
TODO | ||
|
||
## Version Naming Convention | ||
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. | ||
|