linux-kernel - Re: [PATCH 4/4] docs: ubifs-authentication: fix Sphinx warning

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: <20200221155912.GF2031@latitude>
Date:   Fri, 21 Feb 2020 16:59:12 +0100
From:   Jonathan Neuschäfer <j.neuschaefer@....net>
To:     Jonathan Corbet <corbet@....net>
Cc:     Jonathan Neuschäfer <j.neuschaefer@....net>,
        linux-mtd@...ts.infradead.org, Richard Weinberger <richard@....at>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Miklos Szeredi <mszeredi@...hat.com>,
        "Daniel W. S. Almeida" <dwlsalmeida@...il.com>,
        Jaskaran Singh <jaskaransingh7654321@...il.com>,
        "Tobin C. Harding" <tobin@...nel.org>,
        Stefan Hajnoczi <stefanha@...hat.com>,
        "David S. Miller" <davem@...emloft.net>,
        Rob Herring <robh@...nel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jonathan Cameron <Jonathan.Cameron@...wei.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 4/4] docs: ubifs-authentication: fix Sphinx warning

On Wed, Feb 19, 2020 at 04:17:58AM -0700, Jonathan Corbet wrote:
> On Fri, 14 Feb 2020 18:08:07 +0100
> Jonathan Neuschäfer <j.neuschaefer@....net> wrote:
> 
> > This fixes the following warning:
> > 
> > Documentation/filesystems/ubifs-authentication.rst:98: WARNING:
> >   Inline interpreted text or phrase reference start-string without end-string.
> > 
> > Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@....net>
> 
> So this, IMO, should be fixed in patch #2, when you're touching the file
> anyway.  I don't see a lot of value in adding a warning to the docs build
> then immediately removing it.

Good point.

> Also, please send a cover letter with multi-part sets like this so we
> know what the overall objective is.

Ok, I'll remember to do that more.

In this case, I just saw this file and wanted it to work better with
Sphinx.

> Note also that Mauro is also playing with this file (and ubifs.txt, which
> really should be included as well) at the same time.

Hmm. I only saw Mauro's series after sending this one.

I think I'll respin this series after Mauro's is merged, to keep the
potential for merge conflicts low.


Thanks,
Jonathan Neuschäfer

Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)