From 863490931cb7e485e84945477ac82f25597a36d7 Mon Sep 17 00:00:00 2001 From: Florian Pose Date: Fri, 4 Nov 2011 13:19:03 +0100 Subject: [PATCH] Updated configuration docs. --- documentation/ethercat_doc.tex | 75 ++++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 31 deletions(-) diff --git a/documentation/ethercat_doc.tex b/documentation/ethercat_doc.tex index 634c0f71..f7067019 100644 --- a/documentation/ethercat_doc.tex +++ b/documentation/ethercat_doc.tex @@ -19,6 +19,7 @@ \usepackage[nofancy]{rcsinfo} \usepackage{SIunits} \usepackage{amsmath} % for \text{} +\usepackage{longtable} \usepackage{hyperref} \hypersetup{pdfpagelabels,plainpages=false} @@ -2987,11 +2988,15 @@ follow the below commands: Table~\ref{tab:config} lists important configuration switches and options. -\begin{table} - \caption{Configuration options} - \label{tab:config} - \vspace{2mm} - \begin{tabular}{l|p{.3\textwidth}|l} +\begin{longtable}{l|p{.4\textwidth}|l} + \caption{Configuration options}\rule[-5ex]{0mm}{0mm} + \label{tab:config}\\ + +\textbf{Option/Switch} & \textbf{Description} & \textbf{Default}\\\hline +\endfirsthead + +\textbf{Option/Switch} & \textbf{Description} & \textbf{Default}\\\hline +\endhead \bf Option/Switch & \bf Description & \bf Default\\\hline @@ -2999,25 +3004,13 @@ Table~\ref{tab:config} lists important configuration switches and options. \lstinline+--with-linux-dir+ & Linux kernel sources & Use running kernel\\ -\lstinline+--with-rtai-dir+ & RTAI path (only for RTAI example) & \\ +\lstinline+--with-module-dir+ & Subdirectory in the kernel module tree, where +the EtherCAT kernel modules shall be installed. & \textit{ethercat}\\ \hline -\lstinline+--enable-tool+ & Build the command-line tool ``ethercat'' (see -sec.~\ref{sec:tool}). & yes\\ - -\lstinline+--enable-userlib+ & Build the userspace library. & yes\\ - -\lstinline+--enable-eoe+ & Enable EoE support & yes\\ - -\lstinline+--enable-cycles+ & Use CPU timestamp counter. Enable this on Intel -architecture to get finer timing calculation. & no\\ - -\lstinline+--enable-debug-if+ & Create a debug interface for each master & no\\ - -\lstinline+--enable-debug-ring+ & Create a debug ring to record frames & no\\ - -\hline +\lstinline+--enable-generic+ & Build the generic Ethernet driver (see +sec.~\ref{sec:generic-driver}). & no\\ \lstinline+--enable-8139too+ & Build the 8139too driver & yes\\ @@ -3031,19 +3024,41 @@ architecture to get finer timing calculation. & no\\ \lstinline+--with-e1000-kernel+ & e1000 kernel & $\dagger$\\ -\lstinline+--enable-e1000e+ & Enable e1000e driver & no\\ - -\lstinline+--with-e1000e-kernel+ & e1000e kernel & $\dagger$\\ - \lstinline+--enable-r8169+ & Enable r8169 driver & no\\ \lstinline+--with-r8169-kernel+ & r8169 kernel & $\dagger$\\ -\lstinline+--enable-generic+ & Build the generic Ethernet driver (see -sec.~\ref{sec:generic-driver}). & no\\ +\hline - \end{tabular} - \vspace{2mm} +\lstinline+--with-rtai-dir+ & RTAI path (only for RTAI example) & \\ + +\lstinline+--enable-debug-if+ & Create a debug interface for each master & no\\ + +\lstinline+--enable-debug-ring+ & Create a debug ring to record frames & no\\ + +\lstinline+--enable-eoe+ & Enable EoE support & yes\\ + +\lstinline+--enable-cycles+ & Use CPU timestamp counter. Enable this on Intel +architecture to get finer timing calculation. & no\\ + +\lstinline+--enable-hrtimer+ & Use high-resolution timer to let the master +state machine sleep between sending frames. & no\\ + +\lstinline+--enable-regalias+ & Read alias address from register. & no\\ + +\lstinline+--enable-tool+ & Build the command-line tool ``ethercat'' (see +sec.~\ref{sec:tool}). & yes\\ + +\lstinline+--enable-userlib+ & Build the userspace library. & yes\\ + +\lstinline+--enable-tty+ & Build the TTY driver. & no\\ + +\lstinline+--enable-wildcards+ & Enable \textit{0xffffffff} to be wildcards +for vendor ID and product code. & no\\ + +\hline + +\end{longtable} \begin{description} @@ -3052,8 +3067,6 @@ extracted from the Linux kernel sources. \end{description} -\end{table} - \section{Building the Interface Documentation} \label{sec:gendoc}