diff --git a/Doxyfile b/Doxyfile index b74d1ca472ff12906a66f773ba0defbebc01085b..ed1524393bf72a0b9cf70cc3307b06d162515f3b 100644 --- a/Doxyfile +++ b/Doxyfile @@ -23,7 +23,7 @@ PROJECT_NAME = "IgH EtherCAT master" # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 1.1 +PROJECT_NUMBER = 1.1.1 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. diff --git a/INSTALL b/INSTALL index 94387c8c4fcd564666cef998a1ea27c954cade9d..3fefcd5859d0c093f461cb9ac3180905754e6fd2 100644 --- a/INSTALL +++ b/INSTALL @@ -12,7 +12,7 @@ Building and installing The building and installation procedure is described in section 2.1 in the EtherCAT master documentation: - documentation/ethercat-doc.pdf +documentation/ethercat-doc.pdf ------------------------------------------------------------------------------- @@ -20,11 +20,15 @@ For the impatient: The procedure mainly consists of calling - ./configure - make - make install +$ ./configure +$ make modules -...and copying the init script and sysconfig files from $prefix/etc to the +(and as root) + +# make modules_install +# make install + +...and copying the init script and sysconfig file from $prefix/etc to the appropriate locations and customizing the sysconfig file. ------------------------------------------------------------------------------- diff --git a/documentation/ethercat_doc.tex b/documentation/ethercat_doc.tex index b8869520b729d713894ad986301e8c42b00150f5..59d144df6c8a4274f9720791773bbf166cc9f300 100644 --- a/documentation/ethercat_doc.tex +++ b/documentation/ethercat_doc.tex @@ -41,6 +41,8 @@ \SVN $Date$ \SVN $Revision$ +\newcommand{\masterversion}{1.1.1} + \makeindex \makeglossary @@ -56,7 +58,7 @@ \rule{\textwidth}{1.5mm} {\Huge\bf IgH \includegraphics[height=2.4ex]{images/ethercat} - Master 1.1\\[1ex] + Master \masterversion\\[1ex] Documentation} \vspace{1ex} @@ -1290,7 +1292,7 @@ certain functions of the master interfaces. The master module gives information about it's state and events via the syslog interface. The module loading command above should result -in the following syslog messages: +in the syslog messages below (or similar): \begin{lstlisting} EtherCAT: Master driver, 1.1 (stable) - rev. 513, @@ -4299,20 +4301,20 @@ examples for different realtime modules. The current EtherCAT master code is available at~\cite{etherlab} or can be obtained from the EtherLab\textsuperscript{\textregistered} CD. -The \textit{tar.bz2} file has to be unpacked with the command below +The \textit{tar.bz2} file has to be unpacked with the commands below (or similar): \begin{lstlisting} - `\$` `\textbf{tar xjf ethercat-1.1-rXXX.tar.bz2}` - `\$` `\textbf{cd ethercat-1.1-rXXX/}` + `\$` `\textbf{tar xjf ethercat-\masterversion.tar.bz2}` + `\$` `\textbf{cd ethercat-\masterversion/}` \end{lstlisting} The tarball was created with GNU Autotools, so the build process -follows the usual commands: +follows the below commands: \begin{lstlisting} `\$` `\textbf{./configure}` - `\$` `\textbf{make}` + `\$` `\textbf{make modules}` \end{lstlisting} The default installation prefix is \textit{/opt/etherlab}. It can be @@ -4327,17 +4329,30 @@ argument. Example: \begin{lstlisting} `\$` `\textbf{./configure --with-linux="2.6.17-ipipe"}` - `\$` `\textbf{make}` + `\$` `\textbf{make modules}` \end{lstlisting} -The following commands have to be entered as \textit{root}: To install -the kernel modules, headers, the init script, the sysconfig file and -the user space tools, the below command has to be executed: +The below commands have to be entered as \textit{root}: The first one +will install the kernel modules to the kernel's modules directory. The +second one will install EtherCAT headers, the init script, the +sysconfig file and the user space tools to the prefix path. \begin{lstlisting} + # `\textbf{make modules\_install}` # `\textbf{make install}` \end{lstlisting} +If the target kernel's modules directory is not under +\textit{/lib/modules}, a different destination directory can be +specified with the \textit{DESTDIR} make variable. For example: + +\begin{lstlisting} + # `\textbf{make DESTDIR=/vol/nfs/root modules\_install}` +\end{lstlisting} + +This command will install the compiled kernel modules to +\textit{/vol/nfs/root/lib/modules}, prepended by the kernel release. + If the EtherCAT master shall be run as a service (recommended\footnote{Even if the EtherCAT master shall not be loaded on system startup, the use of the init script is recommended for