netdev - Re: [PATCH] docs: networking: Add title caret and missing doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190930113754.5902855e@cakuba.netronome.com>
Date:   Mon, 30 Sep 2019 11:37:54 -0700
From:   Jakub Kicinski <jakub.kicinski@...ronome.com>
To:     Adam Zerella <adam.zerella@...il.com>
Cc:     davem@...emloft.net, netdev@...r.kernel.org,
        linux-doc@...r.kernel.org
Subject: Re: [PATCH] docs: networking: Add title caret and missing doc

On Sat, 28 Sep 2019 22:39:17 +1000, Adam Zerella wrote:
> Resolving a couple of Sphinx documentation warnings
> that are generated in the networking section.
> 
> - WARNING: document isn't included in any toctree
> - WARNING: Title underline too short.
> 
> Signed-off-by: Adam Zerella <adam.zerella@...il.com>
> ---
>  Documentation/networking/device_drivers/index.rst | 1 +
>  Documentation/networking/j1939.rst                | 2 +-
>  2 files changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/networking/device_drivers/index.rst b/Documentation/networking/device_drivers/index.rst
> index f51f92571e39..1f4a629e7caa 100644
> --- a/Documentation/networking/device_drivers/index.rst
> +++ b/Documentation/networking/device_drivers/index.rst
> @@ -24,6 +24,7 @@ Contents:
>     google/gve
>     mellanox/mlx5
>     pensando/ionic
> +   netronome/nfp

I wonder if it's worth keeping the entries in a roughly alphabetic
order?

>  .. only::  subproject and html
>  
> diff --git a/Documentation/networking/j1939.rst b/Documentation/networking/j1939.rst
> index ce7e7a044e08..dc60b13fcd09 100644
> --- a/Documentation/networking/j1939.rst
> +++ b/Documentation/networking/j1939.rst
> @@ -272,7 +272,7 @@ supported flags are:
>  * MSG_DONTWAIT, i.e. non-blocking operation.
>  
>  recvmsg(2)
> -^^^^^^^^^
> +^^^^^^^^^^
>  
>  In most cases recvmsg(2) is needed if you want to extract more information than
>  recvfrom(2) can provide. For example package priority and timestamp. The