documenting System.DllNotFoundException troubleshooting #1085
Conversation
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
badcel
requested changes
Jun 25, 2024
docs/docs/faq.md
Outdated
| 1. Gnome SDK (Linux) | ||
| 2. MSYS2 (Windows) | ||
| 3. Homebrew (MacOS) | ||
|
|
||
| Each of those sources defines the names of the binaries which must be available to call into them. If a custom build binary is used, the resulting name of the binary can differ from the one specified by the package source, thus resulting in a `DllNotFoundException`. | ||
| Each of those sources defines the names of the binaries which must be available to call into them. If a custom build binary is used, the resulting binary name binary may be different from the one specified by the package source, resulting in a `System.DllNotFoundException`. |
There was a problem hiding this comment.
The sentence contains an obsolete binary.
docs/docs/faq.md
Outdated
| The gir.core nuget packages are build against 3 different package sources: | ||
| The `System.DllNotFoundException` can be thrown in the following cases: | ||
|
|
||
| - required DLLs or Shared Objects (the Unix equivalent of DLLs) are not installed in the OS. |
There was a problem hiding this comment.
- Shared objects should probably be lower case?
- OS -> operating system
docs/docs/faq.md
Outdated
|
|
||
| - required DLLs or Shared Objects (the Unix equivalent of DLLs) are not installed in the OS. | ||
|
|
||
| - or you forgot to do a `Module.Initialize()` call before instantiating an object in a namespace like `Gtk`, `Gdk` or `GtkSource`. |
There was a problem hiding this comment.
- Please don't talk to the reader directly / avoid words like
you - Remove empty lines between bullet points
|
If you update the PR can you please amend your changes via |
badcel
requested changes
Jun 27, 2024
There was a problem hiding this comment.
Some more remarks. This time with concrete suggestions to make your life easier.
If you apply them please squash the commits again to avoid having multiple. (This is probably a separate step after applying the changes.)
After this changes I think it is good to go. 🚀
docs/docs/faq.md
Outdated
| The `System.DllNotFoundException` can be thrown in the following cases: | ||
|
|
||
| - required DLLs or shared objects (the Unix equivalent of DLLs) are not installed in the operating system. | ||
| - or `Module.Initialize()` was not called before instantiating an object in a namespace like `Gtk`, `Gdk` or `GtkSource`. |
There was a problem hiding this comment.
Suggested change
| - or `Module.Initialize()` was not called before instantiating an object in a namespace like `Gtk`, `Gdk` or `GtkSource`. | |
| - `Module.Initialize()` was not called before instantiating an object in a namespace like `Gtk`, `Gdk` or `GtkSource`. |
docs/docs/faq.md
Outdated
| - or `Module.Initialize()` was not called before instantiating an object in a namespace like `Gtk`, `Gdk` or `GtkSource`. | ||
| - required DLLs or shared objects are installed, but still `DllNotFoundException` is thrown. In this case, the names of the installed libraries probably don't match the names expected by `gir.core`. This can happen when using a custom build binary. | ||
|
|
||
| ## How can I use gir.core with a custom binary build of Gtk? |
There was a problem hiding this comment.
Suggested change
| ## How can I use gir.core with a custom binary build of Gtk? | |
| ## How can I use gir.core with a custom build native binary? |
docs/docs/faq.md
Outdated
|
|
||
| - required DLLs or shared objects (the Unix equivalent of DLLs) are not installed in the operating system. | ||
| - or `Module.Initialize()` was not called before instantiating an object in a namespace like `Gtk`, `Gdk` or `GtkSource`. | ||
| - required DLLs or shared objects are installed, but still `DllNotFoundException` is thrown. In this case, the names of the installed libraries probably don't match the names expected by `gir.core`. This can happen when using a custom build binary. |
There was a problem hiding this comment.
Suggested change
| - required DLLs or shared objects are installed, but still `DllNotFoundException` is thrown. In this case, the names of the installed libraries probably don't match the names expected by `gir.core`. This can happen when using a custom build binary. | |
| - required DLLs or shared objects are installed, but still `DllNotFoundException` is thrown. In this case, the names of the installed libraries probably don't match the names expected by `gir.core`. This can happen when [using a custom build binary](#how-can-i-use-gircore-with-a-custom-build-native-binary). |
badcel
approved these changes
Jun 28, 2024
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I agree that my contribution may be licensed either under MIT or any version of LGPL license.
addresses Documentation: Improve DLL not found section #1083
I explained how to fix
System.DllNotFoundExceptionby callingModule.Initialize()separated the explanation of
System.DllNotFoundExceptionbeing thrown when a custom build binary is used from the details of how to use a custom binary build.