Skip to content

Documentation: Fix incorrect timer initialization API names - #20013

Merged
acassis merged 1 commit into
apache:masterfrom
arnavsharma990:docs-fix-tickless-api-names
Aug 30, 2026
Merged

Documentation: Fix incorrect timer initialization API names#20013
acassis merged 1 commit into
apache:masterfrom
arnavsharma990:docs-fix-tickless-api-names

Conversation

@arnavsharma990

Copy link
Copy Markdown
Contributor

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() to
up_timer_initialize() and up_intialize() to up_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 adc
example. Adding a new uORB driver may require that you run
uorb_listener to 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.

@Abhishekmishra2808

Copy link
Copy Markdown
Contributor

Thanks @arnavsharma990. Follow the contribution guidelines (https://nuttx.apache.org/docs/latest/contributing/guide.html), 1. Sign the commit msg
2. The commit msg should contain a description of the changes

@arnavsharma990
arnavsharma990 force-pushed the docs-fix-tickless-api-names branch from d0bab93 to 2acb5c7 Compare August 30, 2026 16:58
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
arnavsharma990 force-pushed the docs-fix-tickless-api-names branch from 2acb5c7 to 1684c33 Compare August 30, 2026 17:37
@arnavsharma990

Copy link
Copy Markdown
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.

@github-actions github-actions Bot added Area: Documentation Improvements or additions to documentation Size: XS The size of the change in this PR is very small labels Aug 30, 2026
@acassis
acassis merged commit 0c88b8f into apache:master Aug 30, 2026
7 checks passed
@arnavsharma990
arnavsharma990 deleted the docs-fix-tickless-api-names branch September 1, 2026 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Documentation Improvements or additions to documentation Size: XS The size of the change in this PR is very small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants