2019-05-29 23:25:33

by Mauro Carvalho Chehab

Subject: [PATCH 21/22] docs: net: sja1105.rst: fix table format

There's a table there with produces two warnings when built
with Sphinx:

Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.

It will still produce a table, but the html output is wrong, as
it won't interpret the second line as the continuation for the
first ones, because identation doesn't match.

After the change, the output looks a way better and we got rid
of two warnings.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/networking/dsa/sja1105.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/networking/dsa/sja1105.rst b/Documentation/networking/dsa/sja1105.rst
index ea7bac438cfd..cb2858dece93 100644
--- a/Documentation/networking/dsa/sja1105.rst
+++ b/Documentation/networking/dsa/sja1105.rst
@@ -86,13 +86,13 @@ functionality.
The following traffic modes are supported over the switch netdevices:

+--------------------+------------+------------------+------------------+
-| | Standalone | Bridged with | Bridged with |
-| | ports | vlan_filtering 0 | vlan_filtering 1 |
+| | Standalone | Bridged with | Bridged with |
+| | ports | vlan_filtering 0 | vlan_filtering 1 |
+====================+============+==================+==================+
| Regular traffic | Yes | Yes | No (use master) |
+--------------------+------------+------------------+------------------+
| Management traffic | Yes | Yes | Yes |
-| (BPDU, PTP) | | | |
+| (BPDU, PTP) | | | |
+--------------------+------------+------------------+------------------+

Switching features
--
2.21.0

2019-05-29 23:29:50

by Vladimir Oltean

Subject: Re: [PATCH 21/22] docs: net: sja1105.rst: fix table format

On Thu, 30 May 2019 at 02:24, Mauro Carvalho Chehab
<[email protected]> wrote:
>
> There's a table there with produces two warnings when built
> with Sphinx:
>
> Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/networking/dsa/sja1105.rst:91: WARNING: Block quote ends without a blank line; unexpected unindent.
>
> It will still produce a table, but the html output is wrong, as
> it won't interpret the second line as the continuation for the
> first ones, because identation doesn't match.
>
> After the change, the output looks a way better and we got rid
> of two warnings.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> Documentation/networking/dsa/sja1105.rst | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/networking/dsa/sja1105.rst b/Documentation/networking/dsa/sja1105.rst
> index ea7bac438cfd..cb2858dece93 100644
> --- a/Documentation/networking/dsa/sja1105.rst
> +++ b/Documentation/networking/dsa/sja1105.rst
> @@ -86,13 +86,13 @@ functionality.
> The following traffic modes are supported over the switch netdevices:
>
> +--------------------+------------+------------------+------------------+
> -| | Standalone | Bridged with | Bridged with |
> -| | ports | vlan_filtering 0 | vlan_filtering 1 |
> +| | Standalone | Bridged with | Bridged with |
> +| | ports | vlan_filtering 0 | vlan_filtering 1 |
> +====================+============+==================+==================+
> | Regular traffic | Yes | Yes | No (use master) |
> +--------------------+------------+------------------+------------------+
> | Management traffic | Yes | Yes | Yes |
> -| (BPDU, PTP) | | | |
> +| (BPDU, PTP) | | | |
> +--------------------+------------+------------------+------------------+
>
> Switching features
> --
> 2.21.0
>

Acked-by: Vladimir Oltean <[email protected]>