arjav1528 opened a new pull request, #18521:
URL: https://github.com/apache/nuttx/pull/18521
## Fixes #15778
## Summary
Add user-facing documentation for the `TIOCSERGSTRUCT` debug ioctl and its
`CONFIG_SERIAL_TIOCSERGSTRUCT` Kconfig option to the serial driver
documentation.
## Changes
Extends `Documentation/components/drivers/character/serial.rst` with a new
**Serial Debug Structure (TIOCSERGSTRUCT)** section covering:
- Purpose and scope of the ioctl as a debug-only facility.
- Prerequisites for enabling it: `CONFIG_DEBUG_FEATURES`, `MCU_SERIAL` or
`16550_UART`, and driver-level support (63+ drivers across ARM, ARM64,
RISC-V, Xtensa, and MIPS already implement it).
- `menuconfig` navigation path.
- Warnings that the structure layout is driver-specific, unstable, and must
not be used in production code.
## Testing
- Sphinx HTML build succeeds with no warnings related to the new section.
- Generated HTML output verified to contain the new section with correct
headings, code blocks, notes, and warnings.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
