Merging upstream version 20220525.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

4 files changed, 145 insertions, 18 deletions

diff --git a/ethtool/bin/ethtool-i40e b/linux/share/man/Makefile
index 637ae65..a6d6bf2 100755..100644
--- a/ethtool/bin/ethtool-i40e
+++ b/linux/share/man/Makefile
@@ -1,5 +1,3 @@
-#!/bin/sh
-
 # Open Infrastructure: service-tools
 
 # Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
@@ -19,19 +17,43 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
-set -e
+# Depends: python3-docutils
+
+RST2MAN = rst2man \
+	--no-datestamp \
+	--no-generator \
+	--strict \
+	--strip-comments \
+	--tab-width=4 \
+	--verbose
+
+VERSION := $(shell cat ../../../VERSION.txt)
+
+SHELL := sh -e
+
+all: build
+
+build: man
+
+man: man.in *.rst
+	@echo -n "Creating manpages... "
+
+	@for FILE in *.rst; \
+	do \
+		cp man.in $$(basename $${FILE} .rst); \
+		$(RST2MAN) $${FILE} | \
+		sed	-e '/^.\\" Man page generated/d' \
+			-e '/^.\\" Generated by/d' \
+			-e "s|^\(.TH .*\) \(\"\" \"\"\) |\1 $${VERSION} service-tools |" \
+		>> $$(basename $${FILE} .rst); \
+		echo -n "."; \
+	done
+
+	@echo " done."
 
-PROGRAM="$(basename ${0})"
-DEVICES="$(grep DRIVER=i40e /sys/class/net/*/device/uevent | awk -F/ '{ print $5 }' | sort -V)"
+clean:
+	rm -f *.[0-9]
 
-if [ -z "${DEVICES}" ]
-then
-	echo "'${PROGRAM}': no network devices available with i40e driver"
-fi
+distclean: clean
 
-for DEVICE in ${DEVICES}
-do
-	echo -n "'${DEVICE}': disabling FW LLDP..."
-	ethtool --set-priv-flags ${DEVICE} disable-fw-lldp on
-	echo " done."
-done
+rebuild: clean build
diff --git a/linux/share/man/linux-i40e.1.rst b/linux/share/man/linux-i40e.1.rst
new file mode 100644
index 0000000..f4c2eb7
--- /dev/null
+++ b/linux/share/man/linux-i40e.1.rst
@@ -0,0 +1,85 @@
+.. Open Infrastructure: service-tools
+
+.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+..
+.. SPDX-License-Identifier: GPL-3.0+
+..
+.. This program is free software: you can redistribute it and/or modify
+.. it under the terms of the GNU General Public License as published by
+.. the Free Software Foundation, either version 3 of the License, or
+.. (at your option) any later version.
+..
+.. This program is distributed in the hope that it will be useful,
+.. but WITHOUT ANY WARRANTY; without even the implied warranty of
+.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.. GNU General Public License for more details.
+..
+.. You should have received a copy of the GNU General Public License
+.. along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+==========
+linux-i40e
+==========
+
+------------------------------------------------------------
+setting recommended options for the Linux i40e device driver
+------------------------------------------------------------
+
+:manual section: 1
+:manual group: Open Infrastructure
+
+Synopsis
+========
+
+| **linux-i40e** start|stop|status
+
+Description
+===========
+
+**linux-i40e** sets all recommended options for the Linux i40e device driver.
+
+Recommended options
+===================
+
+| **Enabling disable-fw-lldp**
+| Many Intel network cards such as the X700 Series drop LLDP pakets by default.
+| When using LACP (802.1ad) this has the effect that after a reboot of one switch,
+| the bond interfaces do not recover. Disabling the firewalling of LLDP pakets on
+| the network card allows the operating system (= Linux kernel) to actually recieve
+| the pakets and re-establish the bonded connection.
+
+| **Enabling link-down-on-close**
+| Many Intel network cards such as the X700 Series do not take down the link
+| when the corresponding interface is deconfigured. This is in contrast to the
+| consumer (Intel) network cards that usually do this. Therefore, without enabling
+| the link-down-on-close, most assumptions of HA stacks (e.g. pacemaker/corosync)
+| are not met and can lead to various unwanted effects. Enabling this options
+| restores the usual behaviour.
+
+See also
+========
+
+| ethtool(8),
+| https://www.kernel.org/doc/Documentation/networking/i40e.txt
+
+Homepage
+========
+
+More information about service-tools and the Open Infrastructure project can be
+found on the homepage (https://open-infrastructure.net).
+
+Contact
+=======
+
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<software@lists.open-infrastructure.net>.
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(https://bugs.debian.org).
+
+Authors
+=======
+
+service-tools were written by Daniel Baumann
+<daniel.baumann@open-infrastructure.net> and others.
diff --git a/linux/share/man/man.in b/linux/share/man/man.in
new file mode 100644
index 0000000..f95ca67
--- /dev/null
+++ b/linux/share/man/man.in
@@ -0,0 +1,19 @@
+.\" Open Infrastructure: service-tools
+.\"
+.\" Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+.\"
+.\" SPDX-License-Identifier: GPL-3.0+
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with this program.  If not, see <https://www.gnu.org/licenses/>.
+.\"
diff --git a/ethtool/share/systemd/ethtool-i40e.service b/linux/share/systemd/linux-i40e.service
index e578d35..5d7f99f 100644
--- a/ethtool/share/systemd/ethtool-i40e.service
+++ b/linux/share/systemd/linux-i40e.service
@@ -1,14 +1,15 @@
 # Open Infrastructure: service-tools
 
 [Unit]
-Description=ethtool-i40e options
-Documentation=man:ethotool-i40e
+Description=setting recommended options for the Linux i40e device driver
+Documentation=man:linux-i40e
 Before=network.target
 
 [Service]
 Type=oneshot
 RemainAfterExit=yes
-ExecStart=/usr/bin/ethtool-i40e
+ExecStart=/usr/bin/linux-i40e start
+ExecStop=/usr/bin/linux-i40e stop
 StandardOutput=journal
 StandardError=journal