Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix plugin documentation #181

Closed
mhuzai opened this issue Nov 9, 2020 · 3 comments · Fixed by #384
Closed

Fix plugin documentation #181

mhuzai opened this issue Nov 9, 2020 · 3 comments · Fixed by #384
Labels
bug Something isn't working
Milestone

Comments

@mhuzai
Copy link
Member

mhuzai commented Nov 9, 2020

Step 2 of the writing your plugin tutorial should be common/common.mk

@mhuzai mhuzai added the bug Something isn't working label Nov 9, 2020
@mhuzai mhuzai added this to the 2.3 milestone Nov 9, 2020
@charmoniumQ
Copy link
Member

charmoniumQ commented Nov 9, 2020

  • Step 6: Define virtual void _p_one_iteration() override {}

  • Q: "Where should I put my plugin's code?" A: "If periodically scheduled, _p_one_iteration. If data-driven, sb->schedule(...)."

  • threadloop inherits from plugin, but adds threading functionality. If you don't use _p_one_iteration, inheriting from threadloop is superfluous; Inherit from plugin directly instead.

@charmoniumQ
Copy link
Member

  • Update the v2-latest pointer

  • Explain when one should clone from master

  • Use --single-branch --branch ${branch_name for speed (or maybe delete old branches).

@astro-friedel astro-friedel linked a pull request Sep 18, 2023 that will close this issue
@astro-friedel
Copy link
Contributor

The new documentation has been rewritten for the cmake build system

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Development

Successfully merging a pull request may close this issue.

3 participants