docs: rewrite plugin install/troubleshooting guide#6079
Open
DmitryLambin wants to merge 1 commit into
Open
Conversation
Closes #6078. Reworks two pages that new users hit when adding a plugin: * HowtoAddPluginOverview.dox - new "Trust & safety" section (plugins run with full process privileges) - macOS / Linux deployment sections to match the existing Windows one - macOS recommends user-writable clone first; sudo-into-/Applications documented as advanced with explicit warning about code-signature damage - dyld/RPATH/SONAME troubleshooting (otool -L workflow, install_name_tool, libcpr.1.dylib symlink case) with the rationale for BUILD_WITH_INSTALL_RPATH - "Verifying the install" with concrete log paths per platform and common failure modes - new "Uninstall" section - Windows: clarified "Run as administrator", added CRT mismatch and Defender/SmartScreen notes - Linux: dpkg -L hint for non-.deb installs - reformatted the Version Compatibility section - explicit "What a plugin distribution looks like" so users who receive a precompiled plugin from a third party also have a starting point * ExamplePluginOverview.dox - Linux and macOS Usage sections with CMake invocations against the installed SDK / Frameworks/MeshLib.framework, otool -L verification step - macOS deploy now recommends the cloned-folder approach; system-wide install delegated to HowtoAddPluginOverview to avoid duplicating the code-signature warning - "After install — quick sanity check" log paths
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
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.
Closes #6078.
Summary
Rewrites the two plugin documentation pages that new users land on when adding a plugin to MeshLib or MeshInspector:
HowtoAddPluginOverview.dox— entry point, install + troubleshooting + uninstallExamplePluginOverview.dox— build steps for the example plugin per platformWhat's new
HowtoAddPluginOverview.doxsudo cparbitrary.dylibfiles into/Applications/MeshInspector.appwithout a single word about source verification.sudo-into-/Applications/...(advanced) presented in that order. The sudo path now carries an explicit warning about breaking the bundle's code signature and what to do if Gatekeeper blocks the next launch (codesign --force --sign -).INSTALL_RPATH+BUILD_WITH_INSTALL_RPATH ONwith rationale,otool -Laudit,install_name_tool -changeworkflow with explicit "read your own deps first" guidance (so users do not blindly paste example versions),libcpr.1.dylibsymlink case.dpkg -L meshinspectorhint so users on tarball / AppImage / from-source can find their own paths.ExamplePluginOverview.doxMeshLib.framework/MeshLib_DIR, plus anotool -Lverification step.HowtoAddPluginOverviewrather than duplicated, to keep the code-signature warning in one place.Test plan
\warning/\noteblocks and\sectionanchors used for cross-references).\refanchors point at sections I renamed (onlyHowtoAddPluginOverview_VersionCompatibilitywas added; cross-page references kept).I have not changed code or build logic, so existing CI should pass unchanged.