nuttx/Documentation/components/drivers/special
chao an 0acf6f02f3 docs/syslog: add syslog configuration options documentation
This commit updates the syslog.rst documentation to:
1. Add a new "Overview" section with the syslog-overview.png diagram
2. Introduce a comprehensive "Syslog Configuration Options" chapter
3. Document the CONFIG_SYSLOG_TIMESTAMP_MS option (newly added in driver code)
   - Clarify its dependency on CONFIG_SYSLOG_TIMESTAMP
   - Explain its function: use millisecond (ms) precision instead of default microsecond (µs)
4. Group all syslog Kconfig options by functional role (debug level, formatting, buffer, etc.)
   - Basic Debug Log Level Configuration
   - Message Formatting Configuration (timestamp/metadata/visual)
   - (Other categories follow the syslog system architecture)

The documentation changes align with the recent driver enhancement:
- drivers/syslog: add millisecond option for syslog timestamp formatting
- Maintain consistency between driver code and documentation
- Make syslog configuration options more discoverable for developers

Signed-off-by: chao an <anchao.archer@bytedance.com>
2026-02-27 08:09:31 -03:00
..
image docs/syslog: add syslog configuration options documentation 2026-02-27 08:09:31 -03:00
mtd Documentation: add pages for supported MTD devices 2025-12-31 11:37:49 +08:00
net net/vlan: add some macro for vlan 2025-12-27 11:36:39 +08:00
pci drivers/net: add IGB network card support 2025-07-08 10:02:15 +02:00
power power/battery: fake gauge support for rpmsg communication 2025-12-22 09:15:56 -03:00
rpmsg Documentation/rpmsg: add rpmsg dump documentation 2026-01-30 07:50:11 -03:00
rptun Documents/rptun: add the new rptun framework documents 2026-01-19 14:18:27 +08:00
sensors sensor_monitor: add /proc/sensor_monitor 2026-01-04 09:24:30 -03:00
vhost Documentation/vhost: add Vhost framework documentation 2026-02-04 02:32:02 +08:00
virtio Documentation/virtio: add VirtIO framework documentation 2026-01-28 13:09:19 -03:00
wireless Documentation: Add documentation for RN2XX3 driver 2025-03-06 06:10:19 -03:00
audio.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
clk.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
devicetree.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
devmem.rst driver/mem:add Mem Driver. 2024-08-28 13:59:04 +08:00
dma.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
framebuffer.rst
i2c.rst Documentation: Add I2C bit-bang IO expander driver documentation 2026-01-01 17:08:47 +08:00
i3c.rst drivers/i3c: update i3c driver documentation 2024-09-24 23:36:50 +08:00
index.rst Documentation/vhost: add Vhost framework documentation 2026-02-04 02:32:02 +08:00
ioexpander.rst drivers/ioexpander: add enable & disable macro for gpio SETDEBOUNCE and SETMASK 2026-01-13 09:27:52 -03:00
lcd.rst style: fix typos 2025-04-30 13:45:46 +08:00
mmcsd.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
pinctrl.rst driver/pinctl: add pinctrl framework 2024-09-17 02:25:47 +08:00
pipes.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
ptp.rst Documentation: Add PTP clock driver framework documentation 2025-12-30 10:22:09 -03:00
regmap.rst
reset.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
rwbuffer.rst
sdio.rst
segger.rst Documentation: add segger sysview heap trace example 2024-10-07 17:34:59 +08:00
sensors.rst sensor_monitor: add /proc/sensor_monitor 2026-01-04 09:24:30 -03:00
spi.rst
syslog.rst docs/syslog: add syslog configuration options documentation 2026-02-27 08:09:31 -03:00
sysview.png Documentation: add segger sysview heap trace example 2024-10-07 17:34:59 +08:00
usbdev.rst
usbhost.rst style: fix typos 2025-04-30 13:45:46 +08:00
usbmisc.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
usbmonitor.rst style: fix typos 2025-04-30 13:45:46 +08:00
usbmonitor_wireshark_linux_example_adb.pcapng Documentation: Add usage of Wireshark for USB monitor 2025-01-22 15:17:38 +08:00
usbmonitor_wireshark_linux_example_adb.png Documentation: Add usage of Wireshark for USB monitor 2025-01-22 15:17:38 +08:00
usrsock.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
video.rst Documentation: add dummy pages for missing filesystems and drivers 2023-10-27 13:21:40 -03:00
wireless.rst Documentation: Add documentation for RN2XX3 driver 2025-03-06 06:10:19 -03:00