linux-kernel - Re: [PATCH] Documentation: add ibmvmc to toctree(index) and fix warnings

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: <20190114084615.4f38b265@lwn.net>
Date:   Mon, 14 Jan 2019 08:46:15 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Steven Royer <seroyer@...ux.ibm.com>
Subject: Re: [PATCH] Documentation: add ibmvmc to toctree(index) and fix
 warnings

On Sun, 13 Jan 2019 19:21:46 -0800
Randy Dunlap <rdunlap@...radead.org> wrote:

> Fix Sphinx warnings in ibmvmc.rst, add an index.rst file in
> Documentation/misc-devices/, and insert that index file into the
> top-level index file.
> 
> Documentation/misc-devices/ibmvmc.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
> Documentation/misc-devices/ibmvmc.rst:: WARNING: document isn't included in any toctree
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Steven Royer <seroyer@...ux.ibm.com>
> Cc: Jonathan Corbet <corbet@....net>

Rather than make another new top-level entry to add to the mess there, I
do wonder if this isn't better placed in the driver-api manual.  I *think*
that's appropriate, though the document is a bit vague to use that way.

Oh well, bringing it in and killing some warnings is better than what we
have now, so I've applied it.  We can always move it around later.

Thanks,

jon