linux-kernel - [GIT PULL] Fixes for sphinx 2.0 docs build failures

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: <20190529095408.1429a5ab@lwn.net>
Date:   Wed, 29 May 2019 09:54:08 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Linus Torvalds <torvalds@...ux-foundation.org>
Cc:     LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org
Subject: [GIT PULL] Fixes for sphinx 2.0 docs build failures

The following changes since commit
a65fd4f0def56f59822b2c49522d36319bc8da8b:

  Documentation: kdump: fix minor typo (2019-05-21 09:31:28 -0600)

are available in the Git repository at:

  git://git.lwn.net/linux.git tags/docs-5.2-fixes2

for you to fetch changes up to 551bd3368a7b3cfef01edaade8970948d178d40a:

  drm/i915: Maintain consistent documentation subsection ordering (2019-05-24 09:15:45 -0600)

----------------------------------------------------------------
The Sphinx 2.0 release contained a few incompatible API changes that broke
our extensions and, thus, the documentation build in general.  Who knew
that those deprecation warnings it was outputting actually meant we should
change something?  This set of fixes makes the build work again with
Sphinx 2.0 and eliminates the warnings for 1.8.  As part of that, we also
need a few fixes to the docs for places where the new Sphinx is more
strict.

It is a bit late in the cycle for this kind of change, but it does fix
problems that people are experiencing now.

There has been some talk of raising the minimum version of Sphinx we
support.  I don't want to do that abruptly, though, so these changes add
some glue to continue to support versions back to 1.3.  We will be adding
some infrastructure soon to nudge users of old versions forward, with the
idea of maybe increasing our minimum version (and removing this glue)
sometime in the future.

----------------------------------------------------------------
Jonathan Corbet (7):
      doc: Cope with Sphinx logging deprecations
      doc: Cope with the deprecation of AutoReporter
      docs: fix numaperf.rst and add it to the doc tree
      lib/list_sort: fix kerneldoc build error
      docs: fix multiple doc build warnings in enumeration.rst
      docs: Fix conf.py for Sphinx 2.0
      drm/i915: Maintain consistent documentation subsection ordering

Mauro Carvalho Chehab (1):
      scripts/sphinx-pre-install: make it handle Sphinx versions

 Documentation/admin-guide/mm/index.rst            |  1 +
 Documentation/admin-guide/mm/numaperf.rst         |  2 +-
 Documentation/conf.py                             |  2 +-
 Documentation/firmware-guide/acpi/enumeration.rst |  2 +-
 Documentation/sphinx/kerneldoc.py                 | 44 +++++++++---
 Documentation/sphinx/kernellog.py                 | 28 ++++++++
 Documentation/sphinx/kfigure.py                   | 40 ++++++-----
 drivers/gpu/drm/i915/i915_reg.h                   |  6 +-
 drivers/gpu/drm/i915/intel_workarounds.c          |  2 +-
 lib/list_sort.c                                   |  3 +-
 scripts/sphinx-pre-install                        | 86 +++++++++++++++++++++--
 11 files changed, 173 insertions(+), 43 deletions(-)
 create mode 100644 Documentation/sphinx/kernellog.py