linux-kernel - Re: [PATCH] Documentation/process/changes: Escape --options to fix Sphinx output

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: <CANiq72k7gVJ1gjN-qbkUM_hh=1QEb8ezKb8FnaD9hnF2kka8Ng@mail.gmail.com>
Date:   Thu, 20 Apr 2023 19:16:48 +0200
From:   Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Zipeng Zhang <zhangzipeng0@...mail.com>, ojeda@...nel.org,
        alex.gaynor@...il.com, wedsonaf@...il.com, boqun.feng@...il.com,
        gary@...yguo.net, bjorn3_gh@...tonmail.com, nathan@...nel.org,
        ndesaulniers@...gle.com, trix@...hat.com, masahiroy@...nel.org,
        codeagain@...eagain.dev, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org,
        llvm@...ts.linux.dev
Subject: Re: [PATCH] Documentation/process/changes: Escape --options to fix
 Sphinx output

On Thu, Apr 20, 2023 at 5:40 PM Jonathan Corbet <corbet@....net> wrote:
>
> We have long disabled the "html_use_smartypants" option to prevent Sphinx
> from mangling "--" sequences (among others).  Unfortunately, Sphinx changed
> that option to "smartquotes" in the 1.6.6 release, and seemingly didn't see
> fit to warn about the use of the obsolete option, resulting in the
> aforementioned mangling returning.  Disable this behavior again and hope
> that the option name stays stable for a while.

I think it was deprecated in v1.6, and removed in v1.7. There seems to
be code for printing a deprecation warning during v1.6, though.

> +# If true, Docutils "smart quotes will be used to convert quotes and dashes

Missing quote in "smart quotes"? Or maybe Saxon genitive?

Other than that, sounds good to me!

Reviewed-by: Miguel Ojeda <ojeda@...nel.org>

Cheers,
Miguel