netdev - Re: [PATCH net] docs: netdev-FAQ: add missing underlines to questions

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] [day] [month] [year] [list]

Message-ID: <20201221103343.632e2205@kicinski-fedora-pc1c0hjn.dhcp.thefacebook.com>
Date:   Mon, 21 Dec 2020 10:33:43 -0800
From:   Jakub Kicinski <kuba@...nel.org>
To:     Baruch Siach <baruch@...s.co.il>
Cc:     "David S. Miller" <davem@...emloft.net>,
        Jonathan Corbet <corbet@....net>, netdev@...r.kernel.org,
        linux-doc@...r.kernel.org, Florian Fainelli <f.fainelli@...il.com>
Subject: Re: [PATCH net] docs: netdev-FAQ: add missing underlines to
 questions

On Sun, 20 Dec 2020 10:29:12 +0200 Baruch Siach wrote:
> > I think this and the following fixes should be folded into a single
> > line (unless it's possible in RST for header to span multiple lines):
> >
> > I sent a patch and I'm wondering what happened to it - how can I tell whether it got merged?
> > --------------------------------------------------------------------------------------------
> >
> > To be honest I think we can also drop the Q: and A: prefixes now that
> > we're using RST.
> >
> > And perhaps we can add an index of questions at the beginning of the
> > the file?  
> 
> Sphinx creates side bar index of the questions in the HTML version. See
> 
>   https://www.kernel.org/doc/html/latest/networking/netdev-FAQ.html
> 
> Other formats provide other index methods.

Interesting. It doesn't render the questions in that bar when I build
locally with make htmldocs. But I see it on kernel.org, so I guess
that's what matters most.