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

ztimer_periodic: fix example in documentation #19961

Merged
merged 1 commit into from
Sep 29, 2023

Conversation

benpicco
Copy link
Contributor

Contribution description

The ztimer_periodic callback function must return a bool, but in the example it's a void function.

Testing procedure

Issues/PRs references

@github-actions github-actions bot added Area: timers Area: timer subsystems Area: sys Area: System labels Sep 29, 2023
@benpicco benpicco added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) Area: doc Area: Documentation CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer and removed Area: timers Area: timer subsystems Area: sys Area: System labels Sep 29, 2023
@benpicco benpicco added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Sep 29, 2023
@riot-ci
Copy link

riot-ci commented Sep 29, 2023

Murdock results

✔️ PASSED

278d2c7 ztimer_periodic: fix example in documentation

Success Failures Total Runtime
1 0 1 01m:09s

Artifacts

@benpicco
Copy link
Contributor Author

bors merge

bors bot added a commit that referenced this pull request Sep 29, 2023
19959: pkg/driver_cryptocell_310: Fix Makefile r=benpicco a=mguetschow


### Contribution description

- make sure to download/extract during prepare, instead of build
- this fixes the issue of missing include dependencies for other pkgs at build time

### Testing procedure

- for an app Makefile, include both `c25519` and `driver_cryptocell_310`
- on `master`, `make all` fails with a missing include path from the `driver_cryptocell_310` package
- with this change, it works


### Issues/PRs references

- isolated from #19954 as suggested by `@miri64` 

19960: dist/tools/jlink: fix DBG_PID assignment r=benpicco a=LP-HAW



19961: ztimer_periodic: fix example in documentation r=benpicco a=benpicco



Co-authored-by: Mikolai Gütschow <[email protected]>
Co-authored-by: LP-HAW <[email protected]>
Co-authored-by: Benjamin Valentin <[email protected]>
@bors
Copy link
Contributor

bors bot commented Sep 29, 2023

Build failed (retrying...):

@bors
Copy link
Contributor

bors bot commented Sep 29, 2023

Canceled.

@github-actions github-actions bot added Area: timers Area: timer subsystems Area: sys Area: System and removed Area: doc Area: Documentation labels Sep 29, 2023
@benpicco
Copy link
Contributor Author

bors merge

@bors
Copy link
Contributor

bors bot commented Sep 29, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot merged commit 1ac1693 into RIOT-OS:master Sep 29, 2023
23 checks passed
@benpicco benpicco deleted the ztimer_periodic-doc_fix branch September 30, 2023 11:24
@MrKevinWeiss MrKevinWeiss added this to the Release 2023.10 milestone Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: sys Area: System Area: timers Area: timer subsystems CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants