|
13 | 13 | - [Adding new dependency](#adding-new-dependency)
|
14 | 14 | - [Code coverage](#code-coverage)
|
15 | 15 | - [Debugging](#debugging)
|
16 |
| - - [Checking the UMF version and CMake variables (Linux only)](#checking-the-umf-version-and-cmake-variables-linux-only) |
17 |
| - - [Requirements](#requirements) |
| 16 | + - [Checking UMF version and build options](#checking-umf-version-and-build-options) |
| 17 | + - [Linux](#linux) |
| 18 | + - [Windows](#windows) |
18 | 19 |
|
19 | 20 | Below you'll find instructions on how to contribute to UMF, either with code changes
|
20 | 21 | or issues. All contributions are most welcome!
|
@@ -229,16 +230,29 @@ $ genhtml -o html_report coverage.info
|
229 | 230 |
|
230 | 231 | ## Debugging
|
231 | 232 |
|
232 |
| -### Checking the UMF version and CMake variables (Linux only) |
| 233 | +### Checking UMF version and build options |
233 | 234 |
|
234 |
| -Strings with the UMF version and useful CMake variables can be grepped in the following way: |
| 235 | +From an already built UMF shared library you can obtain UMF precise version and |
| 236 | +CMake variables/options it was built with. It's not only useful to verify what should |
| 237 | +be included within the library, but also for debugging. If you're filing an issue to |
| 238 | +UMF project, please include this information in your ticket. |
| 239 | + |
| 240 | +#### Linux |
| 241 | + |
| 242 | +Make sure the `binutils` package is installed in your system. Then, you can use |
| 243 | +the following grep command: |
235 | 244 |
|
236 | 245 | ```bash
|
237 | 246 | $ strings libumf.so | grep "@(#)"
|
238 | 247 | @(#) Intel(R) UMF version: 0.11.0-dev.git66.g89e3831d
|
239 | 248 | @(#) Intel(R) UMF CMake variables: "CMAKE_BUILD_TYPE:Debug,...
|
240 | 249 | ```
|
241 | 250 |
|
242 |
| -#### Requirements |
| 251 | +Please note, that version available in the name of library file (e.g. `libumf.so.0.11.0`) |
| 252 | +may be not accurate - version coded inside of the library is far more precise. |
| 253 | +
|
| 254 | +#### Windows |
243 | 255 |
|
244 |
| -- binutils package (Linux) |
| 256 | +On Windows, DLL's metadata can be accessed e.g. looking into *Properties* of the dll file |
| 257 | +in the explorer. Look into the *Details* tab for "Product version" and "File description" |
| 258 | +(it contains UMF's build options). |
0 commit comments