From 7fef7573e63086625a42854d208794aa6c3ad564 Mon Sep 17 00:00:00 2001 From: Nicola Fontana Date: Wed, 26 Oct 2022 08:01:57 +0200 Subject: [PATCH 1/2] Fix #31: typos in documentation --- documentation/ethercat_doc.tex | 2 +- documentation/ethercat_doc_fr.tex | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/ethercat_doc.tex b/documentation/ethercat_doc.tex index 8fb6d6d7..a4b7813e 100644 --- a/documentation/ethercat_doc.tex +++ b/documentation/ethercat_doc.tex @@ -451,7 +451,7 @@ MAC addresses for multiple masters have to be separated by commas: The two masters can be addressed by their indices 0 and 1 respectively (see \autoref{fig:masters}). The master index is needed for the -\lstinline+ecrt_master_request()+ function of the application interface (see +\lstinline+ecrt_request_master()+ function of the application interface (see \autoref{chap:api}) and the \lstinline+--master+ option of the \textit{ethercat} command-line tool (see \autoref{sec:tool}), which defaults to $0$. diff --git a/documentation/ethercat_doc_fr.tex b/documentation/ethercat_doc_fr.tex index 5873b9be..3a2e101b 100644 --- a/documentation/ethercat_doc_fr.tex +++ b/documentation/ethercat_doc_fr.tex @@ -499,7 +499,7 @@ Pour plusieurs ma\^itres, des virgules s\'eparent les adresses MAC : Les deux ma\^itres peuvent \^etre adress\'es par leurs indices respectifs 0 et 1 (voir \autoref{fig:masters}). L'index du ma\^itre -est requis par la fonction \lstinline+ecrt_master_request()+ de l'API +est requis par la fonction \lstinline+ecrt_request_master()+ de l'API (voir \autoref{chap:api}) et par l'option \lstinline+--master+ de l'outil de commande en ligne \textit{ethercat} (voir \autoref{sec:tool}), qui vaut $0$ par d\'efaut. From a402594fe8dd2e219ff6c9d1a6dbad09ccba3569 Mon Sep 17 00:00:00 2001 From: Nicola Fontana Date: Thu, 4 May 2023 08:16:10 +0200 Subject: [PATCH 2/2] Add automatic TOC to README.md Manually maintaining the table of contents relies on how HTML fragments are generated, it is prone to errors (infact it is already out of sync) and just plain boring. Unfortunately there is no common agreement on all markdown flavours on how the table of contents must be implemented. Here the `[[_TOC_]]` tag has been used because it is supported by both GitLab and GitHub: https://gitlab.com/gitlab-org/gitlab/-/issues/21901 --- README.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d0ea2037..80da8c46 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,8 @@ This is the README file of the IgH EtherCAT Master. -vim: spelllang=en spell tw=78 - Contents: -- [General Information](#general-information) -- [Requirements](#requirements) -- [Building and Installing](#building-and-installing) -- [Realtime and Tuning](#realtime-and-tuning) -- [License](#license) -- [Coding Style](#coding-style) + +[[_TOC_]] # General Information