netdev - Re: [PATCH v3 net-next] docs: net: add an explanation of VF (and other) Representors

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: <87h712yz02.fsf@meer.lwn.net>
Date:   Tue, 20 Sep 2022 07:08:29 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Edward Cree <ecree.xilinx@...il.com>,
        Bagas Sanjaya <bagasdotme@...il.com>, ecree@...inx.com,
        netdev@...r.kernel.org, linux-net-drivers@....com
Cc:     davem@...emloft.net, kuba@...nel.org, pabeni@...hat.com,
        edumazet@...gle.com, linux-doc@...r.kernel.org,
        jacob.e.keller@...el.com, jesse.brandeburg@...el.com,
        michael.chan@...adcom.com, andy@...yhouse.net, saeed@...nel.org,
        jiri@...nulli.us, snelson@...sando.io, simon.horman@...igine.com,
        alexander.duyck@...il.com, rdunlap@...radead.org, parav@...dia.com,
        roid@...dia.com, marcin.szycik@...ux.intel.com
Subject: Re: [PATCH v3 net-next] docs: net: add an explanation of VF (and
 other) Representors

Edward Cree <ecree.xilinx@...il.com> writes:

> On 06/09/2022 10:29, Bagas Sanjaya wrote:
>> I think by convention, footnotes should be put on bottom of the doc.
>
> Hmm, a quick and unscientific sample of Documentation/ suggests that
>  many/most existing examples put the footnote shortly after the
>  reference or at the end of the section, roughly as I did here.  I
>  looked at five rST files found by "grep \[#\]_" and all of them had
>  the footnote body close to the reference.
> The placement of the footnote text in the generated output is up to
>  the stylesheet / renderer, of course.

We certainly have no established convention in this area as far as I
know, and I'm not convinced we need one.

Bagas, could I ask you please to focus a bit more on doing useful work
and less on telling others how they should be working?

Thanks,

jon