Merge branch 'stable-1.5' of gitlab.com:etherlab.org/ethercat into stable-1.5

.gitlab-ci.yml

@@ -1,5 +1,5 @@
 image:
-    registry.gitlab.com/etherlab.org/build-container-factory/leap-15.2:linux-syms
+    registry.gitlab.com/etherlab.org/build-container-factory/leap-15.3:linux-syms
 
 build:
     stage: build
@@ -10,6 +10,24 @@ build:
         - make -j8 all modules
         - make DISTCHECK_CONFIGURE_FLAGS="--with-linux-dir=/usr/src/linux-obj/$(uname -i)/default" distcheck
 
+# Build ethercat tool subcommand help output for documentation
+commands:
+    stage: build
+    rules:
+        - if: $CI_COMMIT_BRANCH == "stable-1.5"
+    script:
+        - ./bootstrap
+        - ./configure --disable-kernel --disable-userlib
+        - make -j8 all
+        - mkdir documentation/external
+        - make -C documentation ext
+    artifacts:
+        paths:
+            - script/init.d/ethercat
+            - script/ethercat.service
+            - tool/ethercat
+            - documentation/external/
+
 test cmake:
     stage: test
 
@@ -37,7 +55,21 @@ pages:
     artifacts:
         paths:
             - public/
- 
+
+documentation:
+    stage: deploy
+    rules:
+        - if: $CI_COMMIT_BRANCH == "stable-1.5"
+    image: registry.gitlab.com/etherlab.org/build-container-factory/leap-15.3:texlive
+    script:
+        - cd documentation
+        - make
+        - make index
+        - make
+    artifacts:
+        paths:
+            - documentation/*.pdf
+
 # from 'Workflows/MergeRequest-Pipelines.gitlab-ci.yml', but on all branches
 workflow:
     rules:

documentation/Makefile

@@ -13,6 +13,7 @@ LATEX_OPTIONS := -file-line-error-style
 COMMANDS := \
 	alias \
 	config \
+	crc \
 	cstruct \
 	data \
 	debug \
@@ -26,6 +27,7 @@ COMMANDS := \
 	pdos \
 	reg_read \
 	reg_write \
+	rescan \
 	sdos \
 	sii_read \
 	sii_write \
@@ -51,7 +53,9 @@ $(EXT_FILES): $(ETHERCAT_CMD)
 	@echo Creating $@...
 	$(shell $(subst $(EXT_PREFIX),$(ETHERCAT_HELP) ,$@) > $@)
 
-pdf: $(EXT_FILES)
+ext: $(EXT_FILES)
+
+pdf: ext
 	$(MAKE) -C images
 	$(MAKE) -C graphs
 

documentation/ethercat_doc.tex

@@ -2386,6 +2386,13 @@ created, if the \lstinline+udev+ Package is installed. See
 
 %------------------------------------------------------------------------------
 
+\subsection{Display CRC Error Counters}
+\label{sec:ethercat-crc}
+
+\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_crc}
+
+%------------------------------------------------------------------------------
+
 \subsection{Output PDO information in C Language}
 \label{sec:ethercat-cstruct}
 
@@ -2461,6 +2468,13 @@ created, if the \lstinline+udev+ Package is installed. See
 
 %------------------------------------------------------------------------------
 
+\subsection{Trigger a Bus Scan}
+\label{sec:rescan}
+
+\lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_rescan}
+
+%------------------------------------------------------------------------------
+
 \subsection{SDO Dictionary}
 
 \lstinputlisting[basicstyle=\ttfamily\footnotesize]{external/ethercat_sdos}