stable.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* Patch "docs: sphinx-extensions: make rstFlatTable work with docutils 0.13" has been added to the 4.9-stable tree
@ 2017-01-06 14:28 gregkh
  0 siblings, 0 replies; only message in thread
From: gregkh @ 2017-01-06 14:28 UTC (permalink / raw)
  To: mitya57, corbet, gregkh; +Cc: stable, stable-commits


This is a note to let you know that I've just added the patch titled

    docs: sphinx-extensions: make rstFlatTable work with docutils 0.13

to the 4.9-stable tree which can be found at:
    http://www.kernel.org/git/?p=linux/kernel/git/stable/stable-queue.git;a=summary

The filename of the patch is:
     docs-sphinx-extensions-make-rstflattable-work-with-docutils-0.13.patch
and it can be found in the queue-4.9 subdirectory.

If you, or anyone else, feels it should not be added to the stable tree,
please let <stable@vger.kernel.org> know about it.


>From 217e2bfab22e740227df09f22165e834cddd8a3b Mon Sep 17 00:00:00 2001
From: Dmitry Shachnev <mitya57@debian.org>
Date: Sun, 18 Dec 2016 13:11:46 +0300
Subject: docs: sphinx-extensions: make rstFlatTable work with docutils 0.13

From: Dmitry Shachnev <mitya57@debian.org>

commit 217e2bfab22e740227df09f22165e834cddd8a3b upstream.

In docutils 0.13, the return type of get_column_widths method of the
Table directive has changed [1], which breaks our flat-table directive
and leads to a TypeError when trying to build the docs [2].

This patch adds support for the new return type, while keeping support
for older docutils versions too.

[1] https://sourceforge.net/p/docutils/patches/120/
[2] https://sourceforge.net/p/docutils/bugs/303/

Signed-off-by: Dmitry Shachnev <mitya57@debian.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

---
 Documentation/sphinx/rstFlatTable.py |    5 +++++
 1 file changed, 5 insertions(+)

--- a/Documentation/sphinx/rstFlatTable.py
+++ b/Documentation/sphinx/rstFlatTable.py
@@ -157,6 +157,11 @@ class ListTableBuilder(object):
     def buildTableNode(self):
 
         colwidths    = self.directive.get_column_widths(self.max_cols)
+        if isinstance(colwidths, tuple):
+            # Since docutils 0.13, get_column_widths returns a (widths,
+            # colwidths) tuple, where widths is a string (i.e. 'auto').
+            # See https://sourceforge.net/p/docutils/patches/120/.
+            colwidths = colwidths[1]
         stub_columns = self.directive.options.get('stub-columns', 0)
         header_rows  = self.directive.options.get('header-rows', 0)
 


Patches currently in stable-queue which might be from mitya57@debian.org are

queue-4.9/docs-sphinx-extensions-make-rstflattable-work-with-docutils-0.13.patch

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2017-01-06 14:29 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-01-06 14:28 Patch "docs: sphinx-extensions: make rstFlatTable work with docutils 0.13" has been added to the 4.9-stable tree gregkh

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).