Fix lint issues

vyos · May 14, 2024 · 2b0d77b · 2b0d77b
1 parent 98bf155
commit 2b0d77b
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 33 deletions.
diff --git a/docs/configuration/firewall/flowtables.rst b/docs/configuration/firewall/flowtables.rst
@@ -17,7 +17,8 @@ can be done regarding flowtables.
 
 .. cfgcmd:: set firewall flowtables ...
 
-From main structure defined in :doc:`Firewall Overview</configuration/firewall/index>`
+From main structure defined in
+:doc:`Firewall Overview</configuration/firewall/index>`
 in this section you can find detailed information only for the next part
 of the general structure:
 

diff --git a/docs/configuration/firewall/ipv4.rst b/docs/configuration/firewall/ipv4.rst
@@ -16,7 +16,8 @@ Configuration commands covered in this section:
 
 .. cfgcmd:: set firewall ipv4 ...
 
-From main structure defined in :doc:`Firewall Overview</configuration/firewall/index>`
+From main structure defined in
+:doc:`Firewall Overview</configuration/firewall/index>`
 in this section you can find detailed information only for the next part
 of the general structure:
 
@@ -955,13 +956,17 @@ Synproxy
 ********
 Synproxy connections
 
-.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999> action synproxy
-.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999> protocol tcp
-.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999> synproxy tcp mss <501-65535>
+.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999>
+   action synproxy
+.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999>
+   protocol tcp
+.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999>
+   synproxy tcp mss <501-65535>
 
     Set TCP-MSS (maximum segment size) for the connection
 
-.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999> synproxy tcp window-scale <1-14>
+.. cfgcmd:: set firewall ipv4 [input | forward] filter rule <1-999999>
+   synproxy tcp window-scale <1-14>
 
     Set the window scale factor for TCP window scaling
 
@@ -1167,8 +1172,8 @@ Show Firewall log
 .. opcmd:: show log firewall ipv4 name <name> rule <rule>
 
    Show the logs of all firewall; show all ipv4 firewall logs; show all logs
-   for particular hook; show all logs for particular hook and priority; show all logs
-   for particular custom chain; show logs for specific Rule-Set.
+   for particular hook; show all logs for particular hook and priority;
+   show all logs for particular custom chain; show logs for specific Rule-Set.
 
 Example Partial Config
 ======================

diff --git a/docs/configuration/firewall/ipv6.rst b/docs/configuration/firewall/ipv6.rst
@@ -16,7 +16,8 @@ Configuration commands covered in this section:
 
 .. cfgcmd:: set firewall ipv6 ...
 
-From main structure defined in :doc:`Firewall Overview</configuration/firewall/index>`
+From main structure defined in
+:doc:`Firewall Overview</configuration/firewall/index>`
 in this section you can find detailed information only for the next part
 of the general structure:
 
@@ -373,10 +374,12 @@ There are a lot of matching criteria against which the packet can be tested.
    remain valid if the IPv6 prefix changes and the host
    portion of systems IPv6 address is static (for example, with SLAAC or
    `tokenised IPv6 addresses
-   <https://datatracker.ietf.org/doc/id/draft-chown-6man-tokenised-ipv6-identifiers-02.txt>`_)
+   <https://datatracker.ietf.org
+   /doc/id/draft-chown-6man-tokenised-ipv6-identifiers-02.txt>`_)
 
    This functions for both individual addresses and address groups.
 
+   .. stop_vyoslinter
    .. code-block:: none
 
       # Match any IPv6 address with the suffix ::0000:0000:0000:beef
@@ -388,6 +391,8 @@ There are a lot of matching criteria against which the packet can be tested.
       set firewall ipv6 forward filter rule 200 source group address-group WEBSERVERS
       set firewall ipv6 forward filter rule 200 source address-mask ::ffff:ffff:ffff:ffff
 
+   .. start_vyoslinter
+
 .. cfgcmd:: set firewall ipv6 forward filter rule <1-999999>
    source fqdn <fqdn>
 .. cfgcmd:: set firewall ipv6 input filter rule <1-999999>
@@ -941,13 +946,17 @@ Synproxy
 ********
 Synproxy connections
 
-.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999> action synproxy
-.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999> protocol tcp
-.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999> synproxy tcp mss <501-65535>
+.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999>
+   action synproxy
+.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999>
+   protocol tcp
+.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999>
+   synproxy tcp mss <501-65535>
 
     Set TCP-MSS (maximum segment size) for the connection
 
-.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999> synproxy tcp window-scale <1-14>
+.. cfgcmd:: set firewall ipv6 [input | forward] filter rule <1-999999>
+   synproxy tcp window-scale <1-14>
 
     Set the window scale factor for TCP window scaling
 
@@ -1167,8 +1176,8 @@ Show Firewall log
 .. opcmd:: show log firewall ipv6 name <name> rule <rule>
 
    Show the logs of all firewall; show all ipv6 firewall logs; show all logs
-   for particular hook; show all logs for particular hook and priority; show all logs
-   for particular custom chain; show logs for specific Rule-Set.
+   for particular hook; show all logs for particular hook and priority;
+   show all logs for particular custom chain; show logs for specific Rule-Set.
 
 Example Partial Config
 ======================

diff --git a/docs/configuration/service/pppoe-server.rst b/docs/configuration/service/pppoe-server.rst
@@ -48,7 +48,8 @@ Configuring PPPoE Server
   Create `<user>` for local authentication on this system. The users password
   will be set to `<pass>`.
 
-.. cfgcmd:: set service pppoe-server client-ip-pool <POOL-NAME> range <x.x.x.x-x.x.x.x | x.x.x.x/x>
+.. cfgcmd:: set service pppoe-server client-ip-pool <POOL-NAME>
+   range <x.x.x.x-x.x.x.x | x.x.x.x/x>
 
    Use this command to define the first IP address of a pool of
    addresses to be given to pppoe clients. If notation ``x.x.x.x-x.x.x.x``,
@@ -84,7 +85,8 @@ accounts again.
 
   set service pppoe-server authentication mode radius
 
-.. cfgcmd:: set service pppoe-server authentication radius server <server> key <secret>
+.. cfgcmd:: set service pppoe-server authentication radius
+   server <server> key <secret>
 
   Configure RADIUS `<server>` and its required shared `<secret>` for
   communicating with the RADIUS server.
@@ -108,7 +110,8 @@ If you are using OSPF as IGP, always the closest interface connected to the
 RADIUS server is used. With VyOS 1.2 you can bind all outgoing RADIUS requests
 to a single source IP e.g. the loopback interface.
 
-.. cfgcmd:: set service pppoe-server authentication radius source-address <address>
+.. cfgcmd:: set service pppoe-server authentication radius
+   source-address <address>
 
   Source IPv4 address used in all RADIUS server queires.
 
@@ -118,69 +121,83 @@ to a single source IP e.g. the loopback interface.
 RADIUS advanced options
 =======================
 
-.. cfgcmd:: set service pppoe-server authentication radius server <server> port <port>
+.. cfgcmd:: set service pppoe-server authentication radius
+   server <server> port <port>
 
   Configure RADIUS `<server>` and its required port for authentication requests.
 
-.. cfgcmd:: set service pppoe-server authentication radius server <server> fail-time <time>
+.. cfgcmd:: set service pppoe-server authentication radius
+   server <server> fail-time <time>
 
   Mark RADIUS server as offline for this given `<time>` in seconds.
 
-.. cfgcmd:: set service pppoe-server authentication radius server <server> disable
+.. cfgcmd:: set service pppoe-server authentication radius
+   server <server> disable
 
   Temporary disable this RADIUS server.
 
-.. cfgcmd:: set service pppoe-server authentication radius acct-timeout <timeout>
+.. cfgcmd:: set service pppoe-server authentication radius
+   acct-timeout <timeout>
 
   Timeout to wait reply for Interim-Update packets. (default 3 seconds)
 
-.. cfgcmd:: set service pppoe-server authentication radius dynamic-author server <address>
+.. cfgcmd:: set service pppoe-server authentication radius
+   dynamic-author server <address>
 
   Specifies IP address for Dynamic Authorization Extension server (DM/CoA)
 
-.. cfgcmd:: set service pppoe-server authentication radius dynamic-author port <port>
+.. cfgcmd:: set service pppoe-server authentication radius
+   dynamic-author port <port>
 
   Port for Dynamic Authorization Extension server (DM/CoA)
 
 .. cfgcmd:: set service pppoe-server authentication radius dynamic-author key <secret>
 
   Secret for Dynamic Authorization Extension server (DM/CoA)
 
-.. cfgcmd:: set service pppoe-server authentication radius max-try <number>
+.. cfgcmd:: set service pppoe-server authentication radius
+   max-try <number>
 
   Maximum number of tries to send Access-Request/Accounting-Request queries
 
-.. cfgcmd:: set service pppoe-server authentication radius timeout <timeout>
+.. cfgcmd:: set service pppoe-server authentication radius
+   timeout <timeout>
 
   Timeout to wait response from server (seconds)
 
-.. cfgcmd:: set service pppoe-server authentication radius nas-identifier <identifier>
+.. cfgcmd:: set service pppoe-server authentication radius
+   nas-identifier <identifier>
 
   Value to send to RADIUS server in NAS-Identifier attribute and to be matched
   in DM/CoA requests.
 
-.. cfgcmd:: set service pppoe-server authentication radius nas-ip-address <address>
+.. cfgcmd:: set service pppoe-server authentication radius
+   nas-ip-address <address>
 
   Value to send to RADIUS server in NAS-IP-Address attribute and to be matched
   in DM/CoA requests. Also DM/CoA server will bind to that address.
 
-.. cfgcmd:: set service pppoe-server authentication radius source-address <address>
+.. cfgcmd:: set service pppoe-server authentication radius
+   source-address <address>
 
   Source IPv4 address used in all RADIUS server queires.
 
-.. cfgcmd:: set service pppoe-server authentication radius rate-limit attribute <attribute>
+.. cfgcmd:: set service pppoe-server authentication radius
+   rate-limit attribute <attribute>
 
   Specifies which RADIUS server attribute contains the rate limit information.
   The default attribute is ``Filter-Id``.
 
 .. note:: If you set a custom RADIUS attribute you must define it on both
    dictionaries at RADIUS server and client.
 
-.. cfgcmd:: set service pppoe-server authentication radius rate-limit enable
+.. cfgcmd:: set service pppoe-server authentication radius
+   rate-limit enable
 
   Enables bandwidth shaping via RADIUS.
 
-.. cfgcmd:: set service pppoe-server authentication radius rate-limit vendor
+.. cfgcmd:: set service pppoe-server authentication radius
+   rate-limit vendor
 
   Specifies the vendor dictionary, dictionary needs to be in
   /usr/share/accel-ppp/radius.