From ced13b29614d26baaf58658476a05a901f76e2a5 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Wed, 11 Jul 2012 18:45:00 +0000
Subject: [PATCH] Documentation fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/stable_2.4.x@4462 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/ports/RVCT/ARMCMx/port.dox | 11 ++++++++---
 readme.txt                    |  1 +
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/os/ports/RVCT/ARMCMx/port.dox b/os/ports/RVCT/ARMCMx/port.dox
index dd8d1fa80..5d39cf605 100644
--- a/os/ports/RVCT/ARMCMx/port.dox
+++ b/os/ports/RVCT/ARMCMx/port.dox
@@ -140,6 +140,11 @@
  *   easily added by adding a subdirectory under <tt>./os/ports/RVCT/ARMCMx</tt>
  *   and giving it the name of the new device, then copy the files from another
  *   device into the new directory and customize them for the new device.
+ * - The free uVision is not able to handle scatter files, the following
+ *   options are required in the project options under "Preprocesso symbols"
+ *   in order to use the unused RAM as heap automatically:
+ *   <tt>__heap_base__=Image$$RW_IRAM1$$ZI$$Limit
+ *   __heap_end__=Image$$RW_IRAM2$$Base</tt>
  * .
  * @ingroup rvct
  */
@@ -208,13 +213,13 @@
  * @section RVCT_ARMCMx_STARTUP_1 Startup Process
  * The startup process, as implemented, is the following:
  * -# Interrupts are masked globally.
- * -# The two stacks are initialized by assigning them the sizes defined in the
- *    linker script (usually named @p ch.icf).
+ * -# The two stacks are initialized by assigning them the sizes defined in
+ *    <tt>cstartup.s</tt> file and accessible through the configuration wizard.
  * -# The CPU state is switched to Privileged and the PSP stack is used.
  * -# An early initialization routine @p __early_init() is invoked, if the
  *    symbol is not defined then an empty default routine is executed
  *    (weak symbol).
- * -# Control is passed to the C runtime entry point @p __cmain that performs
+ * -# Control is passed to the C runtime entry point @p __main that performs
  *    the required initializations before invoking the @p main() function.
  * .
  * @ingroup RVCT_ARMCMx
diff --git a/readme.txt b/readme.txt
index c47fc66de..09f0c6319 100644
--- a/readme.txt
+++ b/readme.txt
@@ -100,6 +100,7 @@
 - FIX: Fixed error in STM32L-Discovery board.h file (bug 3526918).
 - NEW: Validated CAN driver on STM32F2/F4.
 - Small fixes to the STM32F4 board files.
+- Various documentation fixes and improvements.
 
 *** 2.4.1 ***
 - FIX: Fixed inconsistent LPCxxx Internal RC oscillator names (bug 3524138).