From de29a1f8a94095e066f7dc2d568abbbf9f1012df Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>
Date: Sat, 18 Jun 2011 15:49:59 +0000
Subject: Update documents and comments

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3723 42af7a65-404d-4744-a932-0658087f49c3
---
 nuttx/Documentation/NuttxPortingGuide.html | 46 +++++++++++++++++++++++++++---
 nuttx/arch/avr/src/avr/excptmacros.h       |  2 +-
 nuttx/arch/avr/src/avr/up_switchcontext.S  |  2 +-
 nuttx/configs/teensy/nsh/defconfig         |  2 +-
 nuttx/drivers/serial/serialirq.c           |  4 +--
 5 files changed, 47 insertions(+), 9 deletions(-)

(limited to 'nuttx')

diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index faa9f32cf..e4bcc5d64 100644
--- a/nuttx/Documentation/NuttxPortingGuide.html
+++ b/nuttx/Documentation/NuttxPortingGuide.html
@@ -12,7 +12,7 @@
       <h1><big><font color="#3c34ec">
         <i>NuttX RTOS Porting Guide</i>
       </font></big></h1>
-      <p>Last Updated: May 28, 2011</p>
+      <p>Last Updated: June 18, 2011</p>
     </td>
   </tr>
 </table>
@@ -3208,17 +3208,37 @@ build
   </li>
 </ul>
 
-<h2>General OS setup</h2>
+<h2>Debug Options</h2>
+<p>
+ General Debug setup options are provided to (1) enable and control debug console output, (2) to build NuttX for use with a debugger, and (3) to enable specific debug features:
+ </p>
 <ul>
   <li>
-    <code>CONFIG_DEBUG</code>: enables built-in debug options
+    <code>CONFIG_DEBUG</code>: enables built-in debug options.
+    This includes more extensive parameter checking, debug assertions, and other debug logic.
+    This option is also necessary (but not sufficient) to enable debug console output;
+    Debug console output must also be enabled on a subsystem-by-subsystem basis as described below.
   </li>
   <li>
-    <code>CONFIG_DEBUG_VERBOSE</code>: enables verbose debug output
+    <code>CONFIG_DEBUG_VERBOSE</code>: If debug console output is enabled, the option enables more verbose debug output.
+    Ignored if <code>CONFIG_DEBUG</code> is not defined.
+    If only <code>CONFIG_DEBUG</code> then the only output will be errors, warnings, and critical information.
+    If <code>CONFIG_DEBUG_VERBOSE</code> is defined in addition, then general debug comments will also be included in the console output.
   </li>
   <li>
     <code>CONFIG_DEBUG_SYMBOLS</code>: build without optimization and with debug symbols (needed for use with a debugger).
+    This option has nothing to do with debug output.
   </li>
+  <li>
+    <code>CONFIG_DEBUG_STACK</code>: a few ports include logic to monitor stack usage.
+    If the NuttX port supports this option, it would be enabled with this option.
+    This option also requires <code>CONFIG_DEBUG</code> to enable general debug features.
+  </li>
+</ul>
+<p>
+  If debug features are enabled with <code>CONFIG_DEBUG</code> (and possibly <code>CONFIG_DEBUG_VERBOSE</code>), then debug console output can also be enabled on a subsystem-by-subsystem basis.
+  Below are debug subsystems that are generally available on all platforms:
+<ul>
   <li>
     <code>CONFIG_DEBUG_SCHED</code>: enable OS debug output (disabled by default)
   </li>
@@ -3243,6 +3263,24 @@ build
   <li>
     <code>CONFIG_DEBUG_GRAPHICS</code>: enable NX graphics debug output (disabled by default)
   </li>
+</ul>
+<p>
+  The following debug options may also be used with certain ports that support these features:
+</p>
+<ul>
+  <li>
+    <code>CONFIG_DEBUG_DMA</code>: enable DMA controller debug output (disabled by default)
+  </li>
+  <li>
+    <code>CONFIG_DEBUG_GPIO</code>: enable detail GPIO usage debug output (disabled by default)
+  </li>
+  <li>
+    <code>CONFIG_DEBUG_PAGING</code>: enable on-demand paging debug output (disabled by default)
+  </li>
+</ul>
+
+<h2>General OS setup</h2>
+<ul>
   <li>
     <code>CONFIG_ARCH_LOWPUTC</code>: architecture supports low-level, boot
     time console output
diff --git a/nuttx/arch/avr/src/avr/excptmacros.h b/nuttx/arch/avr/src/avr/excptmacros.h
index 604ad5fae..b1d9583b8 100755
--- a/nuttx/arch/avr/src/avr/excptmacros.h
+++ b/nuttx/arch/avr/src/avr/excptmacros.h
@@ -415,7 +415,7 @@
 
 	.macro	TCB_RESTORE, regs
 
-	/* X [r36:27] points to the resister save block.  Get an offset pointer to the PC in
+	/* X [r36:27] points to the register save block.  Get an offset pointer to the PC in
 	 * Y [r28:29]
 	 */
 
diff --git a/nuttx/arch/avr/src/avr/up_switchcontext.S b/nuttx/arch/avr/src/avr/up_switchcontext.S
index e60939c84..3e451f409 100755
--- a/nuttx/arch/avr/src/avr/up_switchcontext.S
+++ b/nuttx/arch/avr/src/avr/up_switchcontext.S
@@ -122,7 +122,7 @@ up_switchcontext:
 	.global	up_fullcontextrestore
 	.func	up_fullcontextrestore
 up_fullcontextrestore:
-	/* Use X ]r26:r27] to reference the restore structure.  */
+	/* Use X [r26:r27] to reference the restore structure.  */
 
 	movw	r26, r24
 
diff --git a/nuttx/configs/teensy/nsh/defconfig b/nuttx/configs/teensy/nsh/defconfig
index 95010358d..f9bb1927c 100755
--- a/nuttx/configs/teensy/nsh/defconfig
+++ b/nuttx/configs/teensy/nsh/defconfig
@@ -792,7 +792,7 @@ CONFIG_BOOT_COPYTORAM=n
 CONFIG_CUSTOM_STACK=n
 CONFIG_STACK_POINTER=
 CONFIG_IDLETHREAD_STACKSIZE=512
-CONFIG_USERMAIN_STACKSIZE=1024
+CONFIG_USERMAIN_STACKSIZE=512
 CONFIG_PTHREAD_STACK_MIN=256
 CONFIG_PTHREAD_STACK_DEFAULT=512
 CONFIG_HEAP_BASE=
diff --git a/nuttx/drivers/serial/serialirq.c b/nuttx/drivers/serial/serialirq.c
index bc79adc47..18bca2e0c 100644
--- a/nuttx/drivers/serial/serialirq.c
+++ b/nuttx/drivers/serial/serialirq.c
@@ -142,8 +142,8 @@ void uart_recvchars(FAR uart_dev_t *dev)
       nexthead = 0;
     }
 
-  /* Loop putting characters into the receive buffer until eithe: (1) the buffer
-   * is full, or (2) there are not further characters to add.
+  /* Loop putting characters into the receive buffer until either: (1) the buffer
+   * is full, or (2) there are no further characters to add.
    */
 
   while (nexthead != dev->recv.tail && uart_rxavailable(dev))
-- 
cgit v1.2.3