Documentation: Fix incorrect timer initialization API names - #20013
Merged
acassis merged 1 commit intoAug 30, 2026
Conversation
Contributor
|
Thanks @arnavsharma990. Follow the contribution guidelines (https://nuttx.apache.org/docs/latest/contributing/guide.html), 1. Sign the commit msg |
arnavsharma990
force-pushed
the
docs-fix-tickless-api-names
branch
from
August 30, 2026 16:58
d0bab93 to
2acb5c7
Compare
Correct the misspelled up_timer_initialize() and up_initialize() API names in the tickless OS documentation to match the declarations in include/nuttx/arch.h. Signed-off-by: arnavsharma990 <2006arnavsharma@gmail.com>
arnavsharma990
force-pushed
the
docs-fix-tickless-api-names
branch
from
August 30, 2026 17:37
2acb5c7 to
1684c33
Compare
Contributor
Author
|
@Abhishekmishra2808 Thank you for pointing this out. I have updated the commit to include the required signature and a detailed description of the changes, in accordance with the NuttX contribution guidelines. The updated commit has been pushed to the PR. |
xiaoxiang781216
approved these changes
Aug 30, 2026
acassis
approved these changes
Aug 30, 2026
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.
Note: Please adhere to Contributing Guidelines.
Summary
*The tickless OS documentation contains incorrect names for the
platform timer initialization APIs.
This change corrects
up_timer_intialize()toup_timer_initialize()andup_intialize()toup_initialize(),matching the API declarations in
include/nuttx/arch.h.*Impact
Documentation-only change.
Testing
make html
Please provide information about your host machine, the board(s) you
tested your changes on, and how you tested. Logs should be included.
For example, when changing something in the core OS functions, you
may want to run the OSTest application to verify that there are no
regressions. Changes to ADC code may warrant running the
adcexample. Adding a new uORB driver may require that you run
uorb_listenerto verify correct operation.Pure documentation changes can just be tested with
make html(see docs) and verification of the correct format in your
browser.
PRs without testing information will not be accepted. We will
request test logs.