git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7530 35acf78f-673a-0410-8e92-d51de3d6d3f4

doc/common/rsc/footer_html.html

@@ -0,0 +1,12 @@
+    <li class="footer">
+      <a href="http://sourceforge.net/projects/chibios">
+        <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=205897&amp;type=11"
+             border="0" width="120" height="30"
+             alt="Get ChibiOS/RT embedded RTOS at SourceForge.net. Fast,
+                  secure and Free Open Source software downloads"/>
+      </a>
+    </li>
+  </ul>
+</div>
+</body>
+</html>

doc/common/rsc/header_chm.html

@@ -13,7 +13,7 @@
  <tbody>
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
-   <div id="projectname">ChibiOS/RT&#160;<span id="projectnumber">$projectnumber</span></div>
+   <div id="projectname">$projectname&#160;<span id="projectnumber">$projectnumber</span></div>
   </td>
  </tr>
  </tbody>

doc/common/rsc/header_html.html

@@ -20,7 +20,7 @@ $(document).ready(initResizable);
  <tbody>
  <tr style="height: 92px;">
   <td style="padding-left: 0.5em;">
-   <div id="projectname">ChibiOS/RT<br><span id="projectnumber">$projectnumber</span></div>
+   <div id="projectname">$projectname<br><span id="projectnumber">$projectnumber</span></div>
   </td>
   <td style="padding-left: 3em;">
 <script type="text/javascript"><!--

doc/rt/Doxyfile_chm

@@ -31,7 +31,7 @@ PROJECT_NAME           = ChibiOS/RT
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 
-PROJECT_NUMBER         = 2.6.7
+PROJECT_NUMBER         = 3.0.0dev
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer
@@ -581,7 +581,7 @@ FILE_VERSION_FILTER    =
 # You can optionally specify a file name after the option, if omitted
 # DoxygenLayout.xml will be used as the name of the layout file.
 
-LAYOUT_FILE            = ./rsc/layout.xml
+LAYOUT_FILE            = ../common/rsc/layout.xml
 
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
@@ -643,13 +643,12 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../docs/src \
+INPUT                  = ./src \
-                         ../os/kernel \
+                         ../../os/rt/dox \
-                         ../os/ports \
+                         ../../os/rt/src \
-                         ../os/hal \
+                         ../../os/rt/include \
-                         ../os/various \
+                         ../../os/rt/templates \
-                         ../test \
+                         ../../test/rt
-                         ../ext/ext.dox
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -701,20 +700,13 @@ FILE_PATTERNS          = *.c \
 # should be searched for input files as well. Possible values are YES and NO.
 # If left blank NO is used.
 
-RECURSIVE              = YES
+RECURSIVE              = NO
 
 # The EXCLUDE tag can be used to specify files and/or directories that should
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = ../os/ports/common/ARMCMx/CMSIS \
+EXCLUDE                =
-                         ../os/ports/GCC/SIMIA32 \
-                         ../os/hal/platforms \
-                         ../os/hal/templates/meta \
-                         ../os/various\devices_lib \
-                         ../os/various\fatfs_bindings \
-                         ../os/various\lwip_bindings \
-                         ../test/coverage
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -762,7 +754,8 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             = ./rsc
+IMAGE_PATH             = ../common/rsc \
+                         ./rsc
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -910,13 +903,13 @@ HTML_FILE_EXTENSION    = .html
 # that header. Note that the header is subject to change so you typically
 # have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
 
-HTML_HEADER            = ./rsc/header_chm.html
+HTML_HEADER            = ../common/rsc/header_chm.html
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard footer.
 
-HTML_FOOTER            = ./rsc/footer_chm.html
+HTML_FOOTER            = ../common/rsc/footer_chm.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 # style sheet that is used by each HTML page. It can be used to
@@ -1030,7 +1023,7 @@ GENERATE_HTMLHELP      = YES
 # can add a path in front of the file if the result should not be
 # written to the html output directory.
 
-CHM_FILE               = ../ChibiOS_RT.chm
+CHM_FILE               = ../../ChibiOS_RT.chm
 
 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
 # be used to specify the location (absolute path including file name) of
@@ -1760,7 +1753,7 @@ DOT_GRAPH_MAX_NODES    = 20
 # code bases. Also note that the size of a graph can be further restricted by
 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
 
-MAX_DOT_GRAPH_DEPTH    = 3
+MAX_DOT_GRAPH_DEPTH    = 2
 
 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
 # background. This is disabled by default, because dot on Windows does not

doc/rt/Doxyfile_html

@@ -581,7 +581,7 @@ FILE_VERSION_FILTER    =
 # You can optionally specify a file name after the option, if omitted
 # DoxygenLayout.xml will be used as the name of the layout file.
 
-LAYOUT_FILE            = ./rsc/layout.xml
+LAYOUT_FILE            = ../common/rsc/layout.xml
 
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
@@ -643,11 +643,12 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = ../doc/src \
+INPUT                  = ./src \
-                         ../os/rt/dox \
+                         ../../os/rt/dox \
-                         ../os/rt/src \
+                         ../../os/rt/src \
-                         ../os/rt/include \
+                         ../../os/rt/include \
-                         ../os/rt/templates \
+                         ../../os/rt/templates \
+                         ../../test/rt
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -705,14 +706,7 @@ RECURSIVE              = NO
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = ../os/ports/common/ARMCMx/CMSIS \
+EXCLUDE                =
-                         ../os/ports/GCC/SIMIA32 \
-                         ../os/hal/platforms \
-                         ../os/hal/templates/meta \
-                         ../os/various\devices_lib \
-                         ../os/various\fatfs_bindings \
-                         ../os/various\lwip_bindings \
-                         ../test/coverage
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -760,7 +754,8 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             = ./rsc
+IMAGE_PATH             = ../common/rsc \
+                         ./rsc
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -908,13 +903,13 @@ HTML_FILE_EXTENSION    = .html
 # that header. Note that the header is subject to change so you typically
 # have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
 
-HTML_HEADER            = ./rsc/header_html.html
+HTML_HEADER            = ../common/rsc/header_html.html
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard footer.
 
-HTML_FOOTER            = ./rsc/footer_html.html
+HTML_FOOTER            = ../common/rsc/footer_html.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 # style sheet that is used by each HTML page. It can be used to

doc/rt/rsc/footer_html.html

@@ -1,24 +0,0 @@
-    <li class="footer">
-      <a href="http://sourceforge.net/projects/chibios">
-        <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=205897&amp;type=11"
-             border="0" width="120" height="30"
-             alt="Get ChibiOS/RT embedded RTOS at SourceForge.net. Fast,
-                  secure and Free Open Source software downloads"/>
-      </a>
-    </li>
-  </ul>
-</div>
-<!-- Piwik -->
-<script type="text/javascript">
-var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/chibios/" : "http://apps.sourceforge.net/piwik/chibios/");
-document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
-</script><script type="text/javascript">
-piwik_action_name = '';
-piwik_idsite = 1;
-piwik_url = pkBaseURL + "piwik.php";
-piwik_log(piwik_action_name, piwik_idsite, piwik_url);
-</script>
-<object><noscript><p><img src="http://apps.sourceforge.net/piwik/chibios/piwik.php?idsite=1" alt="piwik"/></p></noscript></object>
-<!-- End Piwik Tag -->
-</body>
-</html>

doc/rt/src/main.dox

@@ -26,7 +26,7 @@
 */
 
 /**
- * @mainpage ChibiOS/RT
+ * @mainpage Introdution
  * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
  *
  * <h2>Chibi ?</h2>

os/rt/templates/chcore.h

@@ -233,6 +233,10 @@ struct context {
 /* External declarations.                                                    */
 /*===========================================================================*/
 
+/* The following code is not processed when the file is included from an
+   asm module.*/
+#if !defined(_FROM_ASM_)
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -242,10 +246,16 @@ extern "C" {
 }
 #endif
 
+#endif /* !defined(_FROM_ASM_) */
+
 /*===========================================================================*/
 /* Module inline functions.                                                  */
 /*===========================================================================*/
 
+/* The following code is not processed when the file is included from an
+   asm module.*/
+#if !defined(_FROM_ASM_)
+
 /**
  * @brief   Returns a word encoding the current interrupts status.
  *
@@ -374,6 +384,8 @@ static inline rtcnt_t port_rt_get_counter_value(void) {
 /* Module late inclusions.                                                   */
 /*===========================================================================*/
 
+/* The following code is not processed when the file is included from an
+   asm module.*/
 #if !defined(_FROM_ASM_)
 
 #if CH_CFG_ST_TIMEDELTA > 0

test/rt/test.dox

@@ -27,34 +27,6 @@
  * order to verify the proper working of the kernel, the port and the demo
  * itself.
  *
- * <h2>Strategy by Component</h2>
- * The OS components are tested in various modes depending on their importance:
- * - <b>Kernel</b>. The kernel code is subject to rigorous testing. The test
- *   suite aims to test <b>all</b> the kernel code and reach a code coverage
- *   as close to 100% as possible. In addition to the code coverage, the kernel
- *   code is tested for <b>functionality</b> and benchmarked for <b>speed</b>
- *   and <b>size</b> before each stable release. In addition to the code
- *   coverage and functional testing a <b>batch compilation test</b> is
- *   performed before each release, the kernel is compiled by alternatively
- *   enabling and disabling all the various configuration options, the
- *   kernel code is expected to compile without errors nor warnings and
- *   execute the test suite without failures (a specific simulator is used
- *   for this execution test, it is done automatically by a script because
- *   the entire sequence can take hours).<br>
- *   All the tests results are included as reports in the OS distribution
- *   under <tt>./docs/reports</tt>.
- * - <b>Ports</b>. The port code is tested by executing the kernel test
- *   suite on the target hardware. A port is validated only if it passes all
- *   the tests. Speed and size benchmarks for all the supported architectures
- *   are performed, both size and speed regressions are <b>monitored</b>.
- * - <b>HAL</b>. The HAL high level code and device drivers implementations
- *   are tested through specific test applications under <tt>./testhal</tt>.
- * - <b>Various</b>. The miscellaneous code is tested by use in the various
- *   demos.
- * - <b>External Code</b>. Not tested, external libraries or components are
- *   used as-is or with minor patching where required, problems are usually
- *   reported upstream.
- * .
  * <h2>Kernel Test Suite</h2>
  * The kernel test suite is divided in modules or test sequences. Each Test
  * Module performs a series of tests on a specified kernel subsystem or