From b479c135bfc98a900fa8b51564d316858665cc12 Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Mon, 30 Mar 2015 09:45:56 +0200 Subject: [PATCH] doc: Minor updates and improvements --- doc/rpp_simulink.tex | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/doc/rpp_simulink.tex b/doc/rpp_simulink.tex index bd2e3e0..5f10bcd 100644 --- a/doc/rpp_simulink.tex +++ b/doc/rpp_simulink.tex @@ -1366,7 +1366,7 @@ This chapter describes the implementation of the C support library (RPP Library), which is used both for Simulink code generation target and command line testing tool. -\section{Description} +\section{Introduction} \label{sec-description} The RPP C Support Library (also called RPP library) defines the API for working with the board. It includes drivers and an operating system. @@ -1376,10 +1376,11 @@ to handle the board's peripheral modules in a safe manner. The library is compiled as static library named \texttt{rpp-lib.lib} and can be found in \texttt{\repo/rpp/lib}. -The RPP library can be used in any project, where the RPP hardware support is -required and it is also used in two applications -- the Command line testing -tool, described in Chapter \ref{chap-rpp-test-software}, and Simulink Coder -target, described in Chapter \ref{chap-simulink-coder-target}. +The RPP library can be used in any project, where the RPP hardware +support is required and it is also used in two applications -- +Simulink Coder target, described in Chapter +\ref{chap-simulink-coder-target}, and the command line testing tool, +described in Chapter \ref{chap-rpp-test-software}. For details about the library architecture, refer to Section~\ref{sec-software-architecture}. @@ -1487,7 +1488,7 @@ editor. Most notable rule is that the Tab character is 4 spaces. The RPP library project is prepared for use of a tool named Uncrustify. The Uncrustify tool checks the code and fixes those lines -that does not match the coding style. However, keep in mind that the +that do not match the coding style. However, keep in mind that the program is not perfect and sometimes it can modify code where the suggested coding style has been followed. This does not causes problems as long as the contributor follows the committing procedure @@ -1512,6 +1513,10 @@ git commit --amend \section{Subdirectory content description} \label{sec-rpp-lib-subdirectory-content-description} + +The following files and directories are present in the library source +code package: + \begin{description} \item[rpp-lib.lib and librpp.a] static RPP libraries. @@ -1528,8 +1533,10 @@ git commit --amend to be merged in the future. Also other Hello World applications are included as a reference about how to create an RM48 application. \item[os/] OS layers directory. See - Section~\ref{sec-operating-system-layer} for more information. - information. + Section~\ref{sec-operating-system-layer} for more information about + currently available operating system versions and + Section~\ref{sec-changing-os} for information how to replace the + operating system. \item[rpp/] Main directory for the RPP library. \item[rpp/doc/] RPP Library API documentation. -- 2.39.2