]> rtime.felk.cvut.cz Git - jenkicar/rpp-simulink.git/commitdiff
More documentation updates
authorMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 3 Sep 2015 08:53:07 +0000 (10:53 +0200)
committerMichal Sojka <sojkam1@fel.cvut.cz>
Thu, 3 Sep 2015 10:57:50 +0000 (12:57 +0200)
doc/rpp_simulink.tex

index 1b7bc9af853ca482649e68da86bd8348f311dcda..6dc4b0cad8f574703f3e5ff9cc91270321d93b60 100644 (file)
@@ -170,9 +170,12 @@ Michal \textsc{Sojka}\\[\baselineskip]
            0.6 & 2015-09-03 & Sojka & Multi-rate models can be
                                       compiled in multi-tasking mode
                                       (see
-                                      Sections~\ref{sec-singlet-multit-modes}
+                                      sec.~\ref{sec-singlet-multit-modes}
                                       and \ref{sec:mult-multi-thre}).
-                                      Added board init block (Section \ref{sec:block:sfunction_hydctr_init.c}).
+                                      Added board init block (sec.
+                                      \ref{sec:block:sfunction_hydctr_init.c}).
+                                      Documented halcogen directory in
+                                      sec.~\ref{sec-rpp-lib-subdirectory-content-description}.
            \\\hline
 \end{tabularx}
 
@@ -1374,7 +1377,8 @@ The following are the development guidelines used for developing the RPP API:
 \begin{compactitem}
        \item User documentation should be placed in header files, not in source
 code, and should be Doxygen formatted using autobrief. Documentation for each
-function present is mandatory.
+function present is mandatory and must mention whether the function is
+thread safe or not.
        \item Function declarations in the headers files is for public functions
 only. Do not declare local/static/private functions in the header.
        \item Documentation in source code files should be non-doxygen formatted
@@ -1467,6 +1471,14 @@ This file is used by all applications that need to tun on the RPP
 board, including the Simulink models and test suite. It includes
 instructions for the CGT Linker about target memory layout and where
 to place various code sections.
+
+\item[halcogen/] HalCoGen project files for the supported boards and
+  scripts for automated conversion of HalCoGen-generated files for use
+  in rpp-lib.
+
+  Note: This is work in progress. Currently only ``pinmux'' files for
+  tms570\_hydctr board were produced by the scripts here.
+
 \item[os/] OS layers directory. See
   Section~\ref{sec-operating-system-layer} for more information about
   currently available operating system versions and