docs: correct native lib name in build comment - #3
Open
terbin wants to merge 1 commit into
Open
Conversation
The build comment wrote every artifact with a "lib" prefix
(libPlaceViewer-{arch}.{so/dylib/dll}), but the Windows DLL has no
"lib" prefix: it is PlaceViewer-{arch}.dll, which is exactly what the
Java loader (PlaceViewerLibrary.java) looks up. Split the note per OS
and clarify arch is x86_64/aarch64.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Docs-only fix. The build-instructions comment in
README.mdwrote every native artifact with alibprefix, but the Windows DLL has none. No code or build change.Change
README.md: the build comment read:The
lib...form distributes the prefix across all three extensions, implyinglibPlaceViewer-{arch}.dllon Windows. CMake does not prefixlibto a Windows DLL, so the real artifact isPlaceViewer-{arch}.dll, which is exactly the name the Java loader (PlaceViewerLibrary.java) looks up (PlaceViewer-<arch>.dllon Windows,libPlaceViewer-<arch>.{so,dylib}on Linux/macOS). Split the note per OS and notearchisx86_64/aarch64:Verification
PlaceViewerLibrary.java(libPlaceViewer-<arch>.so/PlaceViewer-<arch>.dll/libPlaceViewer-<arch>.dylib) and against themv/ziplines already in this README, all consistent.