Commit dcf143c2 authored by Stefan Tauner's avatar Stefan Tauner
Browse files

Document the logging process of FIJI in the UM

parent 5de4df45
......@@ -161,5 +161,14 @@ Documentation including demo projects, the technical reference manual and this v
\texttt{hw} contains the VHDL code implementing the \ac{FIC}, \acp{FIU}, UART etc.\ (in \texttt{rtl}) and the respective test benches (in \texttt{tb}) and simulation scripts (in \texttt{sim}).
Media files like logos and icons are found in \texttt{media}.
The \texttt{test} directory comprises tools and data used for testing \ac{FIJI} including a software emulation of the \ac{FIC} and unit tests for the instrumentation code
The \texttt{test} directory comprises tools and data used for testing \ac{FIJI} including a software emulation of the \ac{FIC} and unit tests for the instrumentation code.
Details about testing are described in the \ac{TRM}'s \Cref{TRM:sec:testing}.
\subsubsection{Logging}
All \ac{FIJI} scripts write important messages to the respective terminal (if available) and tool-specific log files.
The log files are saved to \texttt{bin} and get rotated every day (or when one reaches 100\,MB).
Additionally, \acs{FIJIEE} displays them within its GUI and passes them to a user-defined script for reporting/archiving etc.
In the setup step the path of the log file used during instrumentation can be set individually.
The format, verbosity and many other aspects of the logging can be configured in the file \texttt{logger.conf} in the \texttt{bin} directory (see the documentation of \texttt{Log::Log4perl} for details).
......@@ -45,6 +45,7 @@
\lstlistoflistings
\addcontentsline{toc}{section}{\nonumberline List of Listings}
\clearpage
% List of Abbreviations %
\printglossary[style=myAcroStyle,type=acronym,title=List of Abbreviations,toctitle=List of Abbreviations]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment