[PATCH mptcp-net] Documentation: mptcp: fix pm_type formatting

Matthieu Baerts posted 1 patch 3 weeks, 1 day ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/multipath-tcp/mptcp_net-next tags/patchew/20220906122025.743592-1-matthieu.baerts@tessares.net
Maintainers: Mat Martineau <mathew.j.martineau@linux.intel.com>, Eric Dumazet <edumazet@google.com>, Jonathan Corbet <corbet@lwn.net>, Matthieu Baerts <matthieu.baerts@tessares.net>, Jakub Kicinski <kuba@kernel.org>, "David S. Miller" <davem@davemloft.net>, Paolo Abeni <pabeni@redhat.com>
Documentation/networking/mptcp-sysctl.rst | 1 -
1 file changed, 1 deletion(-)
[PATCH mptcp-net] Documentation: mptcp: fix pm_type formatting
Posted by Matthieu Baerts 3 weeks, 1 day ago
When looking at the rendered HTML version, we can see 'pm_type' is not
displayed with a bold font:

  https://docs.kernel.org/5.19/networking/mptcp-sysctl.html

The empty line under 'pm_type' is then removed to have the same style as
the others.

Fixes: 6bb63ccc25d4 ("mptcp: Add a per-namespace sysctl to set the default path manager type")
Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
---

Notes:
    I guess I can send that to netdev, no need to send this specific one to
    Jon Corbet, right?

 Documentation/networking/mptcp-sysctl.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/networking/mptcp-sysctl.rst b/Documentation/networking/mptcp-sysctl.rst
index d9e69fdc7ea3..15f1919d640c 100644
--- a/Documentation/networking/mptcp-sysctl.rst
+++ b/Documentation/networking/mptcp-sysctl.rst
@@ -47,7 +47,6 @@ allow_join_initial_addr_port - BOOLEAN
 	Default: 1
 
 pm_type - INTEGER
-
 	Set the default path manager type to use for each new MPTCP
 	socket. In-kernel path management will control subflow
 	connections and address advertisements according to
-- 
2.37.2


Re: [PATCH mptcp-net] Documentation: mptcp: fix pm_type formatting
Posted by Matthieu Baerts 3 weeks, 1 day ago
Hello,

On 06/09/2022 14:20, Matthieu Baerts wrote:
> When looking at the rendered HTML version, we can see 'pm_type' is not
> displayed with a bold font:
> 
>   https://docs.kernel.org/5.19/networking/mptcp-sysctl.html
> 
> The empty line under 'pm_type' is then removed to have the same style as
> the others.
> 
> Fixes: 6bb63ccc25d4 ("mptcp: Add a per-namespace sysctl to set the default path manager type")
> Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>

I just applied this patch in our tree (fix for -net):

New patches for t/upstream-net:
- 8fe9543c0acd: Documentation: mptcp: fix pm_type formatting
- Results: 9a90302f0e94..6cfce7e8a42a (export-net)

New patches for t/upstream:
- 8fe9543c0acd: Documentation: mptcp: fix pm_type formatting
- Results: cc17a6220548..7191ca91a85d (export)

Cheers,
Matt
-- 
Tessares | Belgium | Hybrid Access Solutions
www.tessares.net

Re: Documentation: mptcp: fix pm_type formatting: Tests Results
Posted by MPTCP CI 3 weeks, 1 day ago
Hi Matthieu,

Thank you for your modifications, that's great!

Our CI did some validations and here is its report:

- KVM Validation: normal:
  - Unstable: 2 failed test(s): packetdrill_add_addr selftest_mptcp_join 🔴:
  - Task: https://cirrus-ci.com/task/6440432971284480
  - Summary: https://api.cirrus-ci.com/v1/artifact/task/6440432971284480/summary/summary.txt

- KVM Validation: debug:
  - Unstable: 1 failed test(s): selftest_mptcp_join 🔴:
  - Task: https://cirrus-ci.com/task/5033058087731200
  - Summary: https://api.cirrus-ci.com/v1/artifact/task/5033058087731200/summary/summary.txt

Initiator: Patchew Applier
Commits: https://github.com/multipath-tcp/mptcp_net-next/commits/578f14d513e3


If there are some issues, you can reproduce them using the same environment as
the one used by the CI thanks to a docker image, e.g.:

    $ cd [kernel source code]
    $ docker run -v "${PWD}:${PWD}:rw" -w "${PWD}" --privileged --rm -it \
        --pull always mptcp/mptcp-upstream-virtme-docker:latest \
        auto-debug

For more details:

    https://github.com/multipath-tcp/mptcp-upstream-virtme-docker


Please note that despite all the efforts that have been already done to have a
stable tests suite when executed on a public CI like here, it is possible some
reported issues are not due to your modifications. Still, do not hesitate to
help us improve that ;-)

Cheers,
MPTCP GH Action bot
Bot operated by Matthieu Baerts (Tessares)