Add an explanation of how plugins work to the manual#5627
Merged
rjbou merged 1 commit intoocaml:masterfrom Feb 5, 2025
Merged
Conversation
avsm
reviewed
Aug 8, 2023
doc/pages/Manual.md
Outdated
| This directory contains symlinks to binaries installed in whichever opam switch | ||
| the plugin it belongs to was installed in. | ||
| These symlinks are added for any packages that have the ["plugin" flag](#opamflag-plugin) | ||
| and have a binary matching their package name. If no binaries with the same name |
Member
There was a problem hiding this comment.
I think the binary only has to match the opam package name by convention; it's not a hard requirement.
Member
Author
There was a problem hiding this comment.
it is a "hard" requirement. A warning will be displayed otherwise and the link will not appear.
Member
There was a problem hiding this comment.
Quite right. The manual needs a tweak to reflect that as well:
https://opam.ocaml.org/doc/Manual.html#opamflag-plugin
plugin: the package installs a program named opam- and may be auto-installed and run with opam . The convention is to name the plugin package opam-.
Contributor
christinerose
left a comment
There was a problem hiding this comment.
A couple of suggestions....
rjbou
reviewed
Sep 20, 2023
8289152 to
b11c530
Compare
rjbou
approved these changes
Feb 5, 2025
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
4 participants
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.
This is fairly hard to explain. Does anyone know a better way to explain it?
cc @christinerose