From: Matthew Wilcox <willy@infradead.org>
To: Jani Nikula <jani.nikula@intel.com>
Cc: Takashi Iwai <tiwai@suse.de>, Jonathan Corbet <corbet@lwn.net>,
Jiri Slaby <jslaby@suse.cz>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] Documentation/sphinx: Fix Directive import error
Date: Fri, 2 Mar 2018 10:28:31 -0800 [thread overview]
Message-ID: <20180302182831.GF31400@bombadil.infradead.org> (raw)
In-Reply-To: <20180302164254.GB31400@bombadil.infradead.org>
On Fri, Mar 02, 2018 at 08:42:54AM -0800, Matthew Wilcox wrote:
> On Fri, Mar 02, 2018 at 06:01:50PM +0200, Jani Nikula wrote:
> > On Fri, 02 Mar 2018, Takashi Iwai <tiwai@suse.de> wrote:
> > > The sphinx.util.compat for Directive stuff was deprecated in the
> > > recent Sphinx version, and now we get a build error.
> > >
> > > Let's import from the new place, docutils.parsers.rst, while keeping
> > > the old sphinx.util.compat as fallback.
> > >
> > > Bugzilla: https://bugzilla.opensuse.org/show_bug.cgi?id=1083694
> > > Signed-off-by: Takashi Iwai <tiwai@suse.de>
> > > ---
> > > v1->v2: Change the fallback order as Matthew suggested, the new one at first
> >
> > So this crossed my mind as well... and then I thought it'll probably
> > succeed on older Sphinx, and the fallback is not needed. The question
> > is, are these equal? Can we just import from docutils.parsers.rst?
>
> I found a github page which implies that docutils.parsers.rst.Directive
> was added 12 years ago (!) so we're probably safe to rely on it:
>
> https://github.com/docutils-mirror/docutils/commit/9649abee47b4ce4db51be1d90fcb1fb500fa78b3
>
> Again, I'm no pythonista, so I may have muddled this.
I spent some time delving through the Sphinx codebase. The compat
version was added so you could use Directive with docutils 0.4 onwards.
docutils 0.5 onwards has Directive. So as long as we're comfortable
mandating docutils from 2009, we're fine ;-)
next prev parent reply other threads:[~2018-03-02 18:28 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-02 15:28 [PATCH v2] Documentation/sphinx: Fix Directive import error Takashi Iwai
2018-03-02 16:01 ` Jani Nikula
2018-03-02 16:42 ` Matthew Wilcox
2018-03-02 18:28 ` Matthew Wilcox [this message]
2018-03-02 16:34 ` Matthew Wilcox
2018-03-02 18:40 ` [PATCH v3] " Matthew Wilcox
2018-03-02 19:00 ` Jani Nikula
2018-03-07 17:12 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180302182831.GF31400@bombadil.infradead.org \
--to=willy@infradead.org \
--cc=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=jslaby@suse.cz \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=tiwai@suse.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).