Skip to content

Commit fb8838e

Browse files
Extend Debug information in CONTRIBUTING.md
Include more precise info on reading UMF vars and version; and add Windows part.
1 parent 2705633 commit fb8838e

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

CONTRIBUTING.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@
1313
- [Adding new dependency](#adding-new-dependency)
1414
- [Code coverage](#code-coverage)
1515
- [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)
1819

1920
Below you'll find instructions on how to contribute to UMF, either with code changes
2021
or issues. All contributions are most welcome!
@@ -229,16 +230,29 @@ $ genhtml -o html_report coverage.info
229230

230231
## Debugging
231232

232-
### Checking the UMF version and CMake variables (Linux only)
233+
### Checking UMF version and build options
233234

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:
235244

236245
```bash
237246
$ strings libumf.so | grep "@(#)"
238247
@(#) Intel(R) UMF version: 0.11.0-dev.git66.g89e3831d
239248
@(#) Intel(R) UMF CMake variables: "CMAKE_BUILD_TYPE:Debug,...
240249
```
241250
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
243255
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

Comments
 (0)