Update plugin driver documentation to reflect native plugin support#52
Merged
thiagoralves merged 1 commit intoDec 22, 2025
Merged
Conversation
- Update README.md to document that native C/C++ plugins are now fully supported - Fix incorrect type comment in plugin_config.h (0=python, 1=native) - Update DEVELOPMENT.md plugin section with accurate lifecycle description - Document native plugin args lifetime (must copy during init) - Update Python import examples to use correct 'from shared import' syntax - Add native plugin examples to See Also section Co-Authored-By: Thiago Alves <thiagoralves@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Update plugin driver documentation to reflect native plugin support
Summary
The plugin driver system documentation was outdated, stating that native C/C++ plugins were "planned for future release" when the implementation already exists. This PR updates the documentation to accurately reflect the current state of the codebase.
Key changes:
plugin_config.h(was0 = native, 1 = python, should be0 = python, 1 = native)from shared importsyntaxSafeLoggingAccessto documented componentscycle_start/cycle_endare reserved hooks (loaded but not currently invoked)Review & Testing Checklist for Human
plugins/native/examples/test_plugin.soand confirm init/start_loop/stop_loop/cleanup are called correctlyfrom shared import SafeBufferAccess, safe_extract_runtime_args_from_capsuleworks in actual pluginsRecommended test plan: Build and run the native plugin example using the Makefile at
plugins/native/examples/, then configure it in plugins.conf with type=1 and verify it loads correctly when the runtime starts.Notes
cycle_startandcycle_endhooks are documented as "reserved" because while the symbols are loaded via dlsym, they are not actually invoked anywhere in the runtime codeLink to Devin run: https://app.devin.ai/sessions/7bb7a40970384ea79ffea4adc955a73a
Requested by: Thiago Alves (@thiagoralves)