diff options
author | Gregory Nutt <gnutt@nuttx.org> | 2014-12-15 19:01:40 -0600 |
---|---|---|
committer | Gregory Nutt <gnutt@nuttx.org> | 2014-12-15 19:01:40 -0600 |
commit | 15c6fe6c0ab549ba13f40e052a807e33dacc7ee9 (patch) | |
tree | 723fe289f18ab36c390b27d5083ac561f99ee89f /nuttx/drivers/syslog | |
parent | 698fba65113ac33982c9fb9b5d7f9399682ec21e (diff) | |
download | nuttx-15c6fe6c0ab549ba13f40e052a807e33dacc7ee9.tar.gz nuttx-15c6fe6c0ab549ba13f40e052a807e33dacc7ee9.tar.bz2 nuttx-15c6fe6c0ab549ba13f40e052a807e33dacc7ee9.zip |
Update README files
Diffstat (limited to 'nuttx/drivers/syslog')
-rw-r--r-- | nuttx/drivers/syslog/README.txt | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/nuttx/drivers/syslog/README.txt b/nuttx/drivers/syslog/README.txt index 26fb43adf..2d0445992 100644 --- a/nuttx/drivers/syslog/README.txt +++ b/nuttx/drivers/syslog/README.txt @@ -29,9 +29,19 @@ Those custom SYSLOG drivers reside in this directory. ramlog.c -------- The RAM logging driver is a driver that was intended to support debugging - output (syslogging) when the normal serial output is not available. For - example, if you are using a telnet or USB serial console, the debug - output will get lost. + output (aka, syslogging). It might be used when the normal serial output + is not available. For example, if you are using a Telnet or USB serial + console, the debug output will get lost since the USB Telnet session does + not use the serial console. + + The RAM logginc driver is also useful when debug output on the serial + console would interfere with performance or with usability. The debug + output is write to RAM very quickly and so interferes less with realtime + performance. And since the output does not appear on the serial console + until you want it to, it does not interfere with the usability of the + serial console. The NuttShell (NSH), for eample, supports a 'dmesg' + command that can be used to dump the buffered output when you want to + see it. The RAM logging driver is similar to a pipe in that it saves the debugging output in a FIFO in RAM. It differs from a pipe in numerous |