[PATCH net] docs: networkng: fix lists and table in sja1105

[PATCH net] docs: networkng: fix lists and table in sja1105

[Jakub Kicinski]

We need an empty line before list stats, otherwise first point
will be smooshed into the paragraph. Inside tables text must
start at the same offset in the cell, otherwise sphinx thinks
it's a new indented block.

Documentation/networking/dsa/sja1105.rst:108: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/networking/dsa/sja1105.rst:112: WARNING: Definition list ends without a blank line; unexpected unindent.
Documentation/networking/dsa/sja1105.rst:245: WARNING: Unexpected indentation.
Documentation/networking/dsa/sja1105.rst:246: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/networking/dsa/sja1105.rst:253: WARNING: Unexpected indentation.
Documentation/networking/dsa/sja1105.rst:254: WARNING: Block quote ends without a blank line; unexpected unindent.

Fixes: a20bc43bfb2e ("docs: net: dsa: sja1105: document the best_effort_vlan_filtering option")
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/dsa/sja1105.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/dsa/sja1105.rst b/Documentation/networking/dsa/sja1105.rst
index b6bbc17814fb..7395a33baaf9 100644
--- a/Documentation/networking/dsa/sja1105.rst
+++ b/Documentation/networking/dsa/sja1105.rst
@@ -103,11 +103,11 @@ To summarize, in each mode, the following types of traffic are supported over
 +-------------+-----------+--------------+------------+
 |             |   Mode 1  |    Mode 2    |   Mode 3   |
 +=============+===========+==============+============+
-|   Regular   |    Yes    |      No      |     Yes    |
+|   Regular   |    Yes    | No           |     Yes    |
 |   traffic   |           | (use master) |            |
 +-------------+-----------+--------------+------------+
 | Management  |    Yes    |     Yes      |     Yes    |
-|   traffic   |           |              |            |
+| traffic     |           |              |            |
 | (BPDU, PTP) |           |              |            |
 +-------------+-----------+--------------+------------+
 
@@ -241,6 +241,7 @@ switch.
 
 In this case, SJA1105 switch 1 consumes a total of 11 retagging entries, as
 follows:
+
 - 8 retagging entries for VLANs 1 and 100 installed on its user ports
   (``sw1p0`` - ``sw1p3``)
 - 3 retagging entries for VLAN 100 installed on the user ports of SJA1105
@@ -249,6 +250,7 @@ In this case, SJA1105 switch 1 consumes a total of 11 retagging entries, as
   reverse retagging.
 
 SJA1105 switch 2 also consumes 11 retagging entries, but organized as follows:
+
 - 7 retagging entries for the bridge VLANs on its user ports (``sw2p0`` -
   ``sw2p3``).
 - 4 retagging entries for VLAN 100 installed on the user ports of SJA1105
-- 
2.26.2

Re: [PATCH net] docs: networkng: fix lists and table in sja1105

[Vladimir Oltean]

On Thu, 11 Jun 2020 at 02:10, Jakub Kicinski <kuba@kernel.org> wrote:
>
> We need an empty line before list stats, otherwise first point
> will be smooshed into the paragraph. Inside tables text must
> start at the same offset in the cell, otherwise sphinx thinks
> it's a new indented block.
>
> Documentation/networking/dsa/sja1105.rst:108: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/networking/dsa/sja1105.rst:112: WARNING: Definition list ends without a blank line; unexpected unindent.
> Documentation/networking/dsa/sja1105.rst:245: WARNING: Unexpected indentation.
> Documentation/networking/dsa/sja1105.rst:246: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/networking/dsa/sja1105.rst:253: WARNING: Unexpected indentation.
> Documentation/networking/dsa/sja1105.rst:254: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> Fixes: a20bc43bfb2e ("docs: net: dsa: sja1105: document the best_effort_vlan_filtering option")
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>
> ---

Acked-by: Vladimir Oltean <vladimir.oltean@nxp.com>

>  Documentation/networking/dsa/sja1105.rst | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/networking/dsa/sja1105.rst b/Documentation/networking/dsa/sja1105.rst
> index b6bbc17814fb..7395a33baaf9 100644
> --- a/Documentation/networking/dsa/sja1105.rst
> +++ b/Documentation/networking/dsa/sja1105.rst
> @@ -103,11 +103,11 @@ To summarize, in each mode, the following types of traffic are supported over
>  +-------------+-----------+--------------+------------+
>  |             |   Mode 1  |    Mode 2    |   Mode 3   |
>  +=============+===========+==============+============+
> -|   Regular   |    Yes    |      No      |     Yes    |
> +|   Regular   |    Yes    | No           |     Yes    |
>  |   traffic   |           | (use master) |            |
>  +-------------+-----------+--------------+------------+
>  | Management  |    Yes    |     Yes      |     Yes    |
> -|   traffic   |           |              |            |
> +| traffic     |           |              |            |
>  | (BPDU, PTP) |           |              |            |
>  +-------------+-----------+--------------+------------+
>
> @@ -241,6 +241,7 @@ switch.
>
>  In this case, SJA1105 switch 1 consumes a total of 11 retagging entries, as
>  follows:
> +
>  - 8 retagging entries for VLANs 1 and 100 installed on its user ports
>    (``sw1p0`` - ``sw1p3``)
>  - 3 retagging entries for VLAN 100 installed on the user ports of SJA1105
> @@ -249,6 +250,7 @@ In this case, SJA1105 switch 1 consumes a total of 11 retagging entries, as
>    reverse retagging.
>
>  SJA1105 switch 2 also consumes 11 retagging entries, but organized as follows:
> +
>  - 7 retagging entries for the bridge VLANs on its user ports (``sw2p0`` -
>    ``sw2p3``).
>  - 4 retagging entries for VLAN 100 installed on the user ports of SJA1105
> --
> 2.26.2
>

Thanks!
-Vladimir

Re: [PATCH net] docs: networkng: fix lists and table in sja1105

[David Miller]

From: Jakub Kicinski <kuba@kernel.org>
Date: Wed, 10 Jun 2020 16:09:06 -0700

> We need an empty line before list stats, otherwise first point
> will be smooshed into the paragraph. Inside tables text must
> start at the same offset in the cell, otherwise sphinx thinks
> it's a new indented block.
> 
> Documentation/networking/dsa/sja1105.rst:108: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/networking/dsa/sja1105.rst:112: WARNING: Definition list ends without a blank line; unexpected unindent.
> Documentation/networking/dsa/sja1105.rst:245: WARNING: Unexpected indentation.
> Documentation/networking/dsa/sja1105.rst:246: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/networking/dsa/sja1105.rst:253: WARNING: Unexpected indentation.
> Documentation/networking/dsa/sja1105.rst:254: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Fixes: a20bc43bfb2e ("docs: net: dsa: sja1105: document the best_effort_vlan_filtering option")
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>

Also applied, thank you.