linux-kernel - [PATCH 0/4] Fix problems on building documentation with Sphinx 1.6

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-next>] [day] [month] [year] [list]

Message-Id: <cover.1503739177.git.mchehab@s-opensource.com>
Date:   Sat, 26 Aug 2017 06:28:24 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Linux Media Mailing List <linux-media@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Jouni Ukkonen <jouni.ukkonen@...el.com>,
        SeongJae Park <sj38.park@...il.com>,
        Ricardo Ribalda Delgado <ricardo.ribalda@...il.com>,
        Markus Heiser <markus.heiser@...marit.de>,
        Evgeni Raikhel <evgeni.raikhel@...el.com>,
        Masanari Iida <standby24x7@...il.com>,
        Hans Verkuil <hans.verkuil@...co.com>,
        Laurent Pinchart <laurent.pinchart+renesas@...asonboard.com>,
        Neil Armstrong <narmstrong@...libre.com>,
        Daniel Vetter <daniel.vetter@...ll.ch>,
        Pavel Machek <pavel@....cz>,
        Archit Taneja <architt@...eaurora.org>,
        Sakari Ailus <sakari.ailus@...ux.intel.com>,
        Aviv Greenberg <aviv.d.greenberg@...el.com>,
        Charles-Antoine Couret <charles-antoine.couret@...vision.fr>
Subject: [PATCH 0/4] Fix problems on building documentation with Sphinx 1.6

Sphinx 1.6 changed the way tables are produced, adding some new
macros before tables that do vertical alignments. This is incompatible
with adjustbox, used by the media book, causing build to fail.

This series fix such issues and make the layout on Sphinx 1.6 acceptable.

The first patch in this series is just a minor fix: it adjust the top and
bottom margins to 1 inch, for newer Sphinx versions, just like on
Spinx 1.4;

The second patch gets rid of adjustbox at the media book and 
adjust its tables to better fit on the output layout, making it
compatible with Sphinx 1.6;

The third patch updates sphinx.rst to remove the restriction for
Sphinx 1.6.

The final patch is just a cleanup patch: it removes adjustbox dependency
from LaTeX output and stop requiring it when checking for
build system dependencies. It should only be applied after
patch 2 is merged.

Jon,

IMHO, the best is if I apply patch 2 on my trees. Please apply
patches 1 and 3 on your tree.

Patch 4 can only be applied after  patch 2 gets merged, but it
is just a cleanup patch that can be applied any time later.

Mauro Carvalho Chehab (4):
  docs-rst: fix verbatim font size on tables
  media: fix pdf build with Spinx 1.6
  sphinx.rst: Allow Sphinx version 1.6 at the docs
  docs-rst: don't require adjustbox anymore

 Documentation/conf.py                              |   5 +-
 Documentation/doc-guide/sphinx.rst                 |   4 +-
 Documentation/media/uapi/v4l/dev-meta.rst          |   2 +
 Documentation/media/uapi/v4l/dev-sliced-vbi.rst    |  23 ++-
 Documentation/media/uapi/v4l/dev-subdev.rst        |   6 +-
 Documentation/media/uapi/v4l/extended-controls.rst |   6 +-
 Documentation/media/uapi/v4l/pixfmt-inzi.rst       |   7 +-
 Documentation/media/uapi/v4l/pixfmt-packed-hsv.rst |  30 ++--
 Documentation/media/uapi/v4l/pixfmt-packed-rgb.rst | 186 +++++++++++----------
 Documentation/media/uapi/v4l/pixfmt-packed-yuv.rst |  50 +++---
 Documentation/media/uapi/v4l/pixfmt-srggb10p.rst   |   7 +-
 Documentation/media/uapi/v4l/subdev-formats.rst    |  17 +-
 Documentation/media/uapi/v4l/vidioc-dqevent.rst    |   2 +-
 .../media/uapi/v4l/vidioc-dv-timings-cap.rst       |   2 +-
 .../media/uapi/v4l/vidioc-enum-frameintervals.rst  |   2 +
 Documentation/media/uapi/v4l/vidioc-enumstd.rst    |   9 +-
 .../media/uapi/v4l/vidioc-g-dv-timings.rst         |   4 +-
 .../media/uapi/v4l/vidioc-g-enc-index.rst          |   2 +-
 .../media/uapi/v4l/vidioc-g-ext-ctrls.rst          |   2 +-
 .../media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst     |   6 +-
 Documentation/media/uapi/v4l/vidioc-g-tuner.rst    |   4 +-
 Documentation/media/uapi/v4l/vidioc-queryctrl.rst  |   2 +-
 scripts/sphinx-pre-install                         |   1 -
 23 files changed, 204 insertions(+), 175 deletions(-)

-- 
2.13.3