Documentation/uorb: Fix command references in uORB docs.#18928
Merged
xiaoxiang781216 merged 1 commit intoMay 21, 2026
Conversation
Align the uORB application documentation with the actual command names, source layout, and configuration options in apps/system/uorb. This updates the page to describe both uorb_listener and uorb_generator, uses the registered NSH command names in usage examples, and documents the listener and generator options to match the current implementation. It also adds the relevant Kconfig enablement notes so the documented commands are easier to find and use. Tested with: - make html SPHINXOPTS="-W" -j Signed-off-by: hanzhijian <hanzhijian@zepp.com>
Zepp-Hanzj
requested review from
Donny9,
anchao and
xiaoxiang781216
as code owners
linguini1
approved these changes
May 21, 2026
Contributor
|
Was it not determined that uorb_generator doesn't exist in the NuttX apps tree? |
xiaoxiang781216
approved these changes
May 21, 2026
Contributor
Author
|
uorb_generator does exist in the current nuttx-apps master. It is registered in system/uorb/Makefile and CMakeLists.txt, controlled by CONFIG_UORB_GENERATOR in Kconfig, and implemented in system/uorb/generator.c. It was introduced by commit 9cf9b862c, so the doc update is aligned with current mainline.
***@***.***
From: Matteo Golin
Date: 2026-05-21 21:37
To: apache/nuttx
CC: Zepp-Hanzj; Author
Subject: Re: [apache/nuttx] Documentation/uorb: Fix command references in uORB docs. (PR #18928)
linguini1 left a comment (apache/nuttx#18928)
Was it not determined that uorb_generator doesn't exist in the NuttX apps tree?
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications on the go with GitHub Mobile for iOS or Android.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
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
3 participants
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.
Summary
Align the uORB application documentation with the actual command names,
source layout, and configuration options in
apps/system/uorb.Details
This PR updates
Documentation/applications/system/uorb/index.rstto:uorb_listeneranduorb_generatorapps/system/uorbImpact
Documentation only. No runtime behavior changes.
Testing